<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>TeamSpeak 3 PHP Framework: TeamSpeak3/TeamSpeak3.php Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="TeamSpeak.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">TeamSpeak 3 PHP Framework
   &#160;<span id="projectnumber">1.1.23</span>
   </div>
   <div id="projectbrief">Copyright © Planet TeamSpeak. All rights reserved.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="annotated.html"><span>Classes</span></a></li>
      <li class="current"><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('_team_speak3_8php_source.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Pages</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">TeamSpeak3.php</div>  </div>
</div><!--header-->
<div class="contents">
<a href="_team_speak3_8php.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;&lt;?php</div>
<div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment"> * @file</span></div>
<div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment"> * TeamSpeak 3 PHP Framework</span></div>
<div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment"> * $Id: TeamSpeak3.php 10/11/2013 11:35:21 scp@orilla $</span></div>
<div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment"> * This program is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment"> * the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment"> * This program is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="comment"> * along with this program. If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;<span class="comment"> * @package   TeamSpeak3</span></div>
<div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="comment"> * @version   1.1.23</span></div>
<div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="comment"> * @author    Sven &#39;ScP&#39; Paulsen</span></div>
<div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;<span class="comment"> * @copyright Copyright (c) 2010 by Planet TeamSpeak. All rights reserved.</span></div>
<div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">/**</span></div>
<div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="comment"> * @class TeamSpeak3</span></div>
<div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="comment"> * @brief Factory class all for TeamSpeak 3 PHP Framework objects.</span></div>
<div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"><a class="code" href="class_team_speak3.html">   32</a></span>&#160;<span class="keyword">class </span><a class="code" href="class_team_speak3.html" title="Factory class all for TeamSpeak 3 PHP Framework objects. ">TeamSpeak3</a></div>
<div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;{<span class="comment"></span></div>
<div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00035"></a><span class="lineno">   35</span>&#160;<span class="comment">   * TeamSpeak 3 protocol welcome message.</span></div>
<div class="line"><a name="l00036"></a><span class="lineno">   36</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae31cefccb5993d1b5fa8fa9f52180bfe">   37</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae31cefccb5993d1b5fa8fa9f52180bfe" title="TeamSpeak 3 protocol welcome message. ">READY</a> = <span class="stringliteral">&quot;TS3&quot;</span>;</div>
<div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;<span class="comment">   * TeamSpeak 3 protocol greeting message prefix.</span></div>
<div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a483d97eee2596af11821f74c6d1b83e0">   42</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a483d97eee2596af11821f74c6d1b83e0" title="TeamSpeak 3 protocol greeting message prefix. ">GREET</a> = <span class="stringliteral">&quot;Welcome&quot;</span>;</div>
<div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;<span class="comment">   * TeamSpeak 3 protocol error message prefix.</span></div>
<div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a5e20ff014c021e5dc0f04777b272ec84">   47</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a5e20ff014c021e5dc0f04777b272ec84" title="TeamSpeak 3 protocol error message prefix. ">ERROR</a> = <span class="stringliteral">&quot;error&quot;</span>;</div>
<div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00050"></a><span class="lineno">   50</span>&#160;<span class="comment">   * TeamSpeak 3 protocol event message prefix.</span></div>
<div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a4dbceb88091137f08da2f78d893a22c9">   52</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a4dbceb88091137f08da2f78d893a22c9" title="TeamSpeak 3 protocol event message prefix. ">EVENT</a> = <span class="stringliteral">&quot;notify&quot;</span>;</div>
<div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="comment">   * TeamSpeak 3 protocol server connection handler ID prefix.</span></div>
<div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a19d4d49947f93c087729848de6d71986">   57</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a19d4d49947f93c087729848de6d71986" title="TeamSpeak 3 protocol server connection handler ID prefix. ">SCHID</a> = <span class="stringliteral">&quot;selected&quot;</span>;</div>
<div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;<span class="comment">   * TeamSpeak 3 PHP Framework version.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7d31dad145adb2a70ac9ae92adeebb5b">   62</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7d31dad145adb2a70ac9ae92adeebb5b" title="TeamSpeak 3 PHP Framework version. ">LIB_VERSION</a> = <span class="stringliteral">&quot;1.1.23&quot;</span>;</div>
<div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;</div>
<div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;<span class="comment">   * TeamSpeak 3 protocol separators.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a1a5f95e94ebee25f7a7de47186fd7acc">   67</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a1a5f95e94ebee25f7a7de47186fd7acc" title="protocol line separator ">SEPARATOR_LINE</a>               = <span class="stringliteral">&quot;\n&quot;</span>; <span class="comment">//!&lt; protocol line separator</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a407829d390331e34c6f90d9df78ae6c5">   68</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a407829d390331e34c6f90d9df78ae6c5" title="protocol list separator ">SEPARATOR_LIST</a>               = <span class="stringliteral">&quot;|&quot;</span>;  <span class="comment">//!&lt; protocol list separator</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a68cea90e6bd99a1aaf9b19325d0f02bb">   69</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a68cea90e6bd99a1aaf9b19325d0f02bb" title="protocol cell separator ">SEPARATOR_CELL</a>               = <span class="stringliteral">&quot; &quot;</span>;  <span class="comment">//!&lt; protocol cell separator</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac9b701c7439f38c391baba51f9b6d1da">   70</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac9b701c7439f38c391baba51f9b6d1da" title="protocol pair separator ">SEPARATOR_PAIR</a>               = <span class="stringliteral">&quot;=&quot;</span>;  <span class="comment">//!&lt; protocol pair separator</span></div>
<div class="line"><a name="l00071"></a><span class="lineno">   71</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00072"></a><span class="lineno">   72</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00073"></a><span class="lineno">   73</span>&#160;<span class="comment">   * TeamSpeak 3 log levels.</span></div>
<div class="line"><a name="l00074"></a><span class="lineno">   74</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7febc9b704013d3a218171fbf5230998">   75</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7febc9b704013d3a218171fbf5230998" title="0: these messages stop the program ">LOGLEVEL_CRITICAL</a>            = 0x00; <span class="comment">//!&lt; 0: these messages stop the program</span></div>
<div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a978acb82eda7f57b72a15c231ed7de26">   76</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a978acb82eda7f57b72a15c231ed7de26" title="1: everything that is really bad ">LOGLEVEL_ERROR</a>               = 0x01; <span class="comment">//!&lt; 1: everything that is really bad</span></div>
<div class="line"><a name="l00077"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a9ac856cab800709d07bc6b53b84d404f">   77</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a9ac856cab800709d07bc6b53b84d404f" title="2: everything that might be bad ">LOGLEVEL_WARNING</a>             = 0x02; <span class="comment">//!&lt; 2: everything that might be bad</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aa157f891770ebc32c3387769419f8bcf">   78</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aa157f891770ebc32c3387769419f8bcf" title="3: output that might help find a problem ">LOGLEVEL_DEBUG</a>               = 0x03; <span class="comment">//!&lt; 3: output that might help find a problem</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a4b19b7a03ed2787450ea21229854ced8">   79</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a4b19b7a03ed2787450ea21229854ced8" title="4: informational output ">LOGLEVEL_INFO</a>                = 0x04; <span class="comment">//!&lt; 4: informational output</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a0ac677fa9a62b01a3a2619f874278654">   80</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a0ac677fa9a62b01a3a2619f874278654" title="5: development output ">LOGLEVEL_DEVEL</a>               = 0x05; <span class="comment">//!&lt; 5: development output</span></div>
<div class="line"><a name="l00081"></a><span class="lineno">   81</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00082"></a><span class="lineno">   82</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00083"></a><span class="lineno">   83</span>&#160;<span class="comment">   * TeamSpeak 3 token types.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno">   84</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"><a class="code" href="class_team_speak3.html#add756e636bc8ea39128fdf8361ffd54c">   85</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#add756e636bc8ea39128fdf8361ffd54c" title="0: server group token (id1={groupID} id2=0) ">TOKEN_SERVERGROUP</a>            = 0x00; <span class="comment">//!&lt; 0: server group token  (id1={groupID} id2=0)</span></div>
<div class="line"><a name="l00086"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae900e81e1e6607ad4294b17f62112685">   86</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae900e81e1e6607ad4294b17f62112685" title="1: channel group token (id1={groupID} id2={channelID}) ">TOKEN_CHANNELGROUP</a>           = 0x01; <span class="comment">//!&lt; 1: channel group token (id1={groupID} id2={channelID})</span></div>
<div class="line"><a name="l00087"></a><span class="lineno">   87</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00088"></a><span class="lineno">   88</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00089"></a><span class="lineno">   89</span>&#160;<span class="comment">   * TeamSpeak 3 codec identifiers.</span></div>
<div class="line"><a name="l00090"></a><span class="lineno">   90</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00091"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a73cb8b928682f11db10d5f4bf92c579d">   91</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a73cb8b928682f11db10d5f4bf92c579d" title="0: speex narrowband (mono, 16bit, 8kHz) ">CODEC_SPEEX_NARROWBAND</a>       = 0x00; <span class="comment">//!&lt; 0: speex narrowband     (mono, 16bit, 8kHz)</span></div>
<div class="line"><a name="l00092"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7e144effeaf513a660467a0dadd1ae97">   92</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7e144effeaf513a660467a0dadd1ae97" title="1: speex wideband (mono, 16bit, 16kHz) ">CODEC_SPEEX_WIDEBAND</a>         = 0x01; <span class="comment">//!&lt; 1: speex wideband       (mono, 16bit, 16kHz)</span></div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ab1b79661570e52e80cb9382286c3f0a6">   93</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ab1b79661570e52e80cb9382286c3f0a6" title="2: speex ultra-wideband (mono, 16bit, 32kHz) ">CODEC_SPEEX_ULTRAWIDEBAND</a>    = 0x02; <span class="comment">//!&lt; 2: speex ultra-wideband (mono, 16bit, 32kHz)</span></div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a8706d107a6d0bd56003436cf91931015">   94</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a8706d107a6d0bd56003436cf91931015" title="3: celt mono (mono, 16bit, 48kHz) ">CODEC_CELT_MONO</a>              = 0x03; <span class="comment">//!&lt; 3: celt mono            (mono, 16bit, 48kHz)</span></div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac8a12a60994f2949c63e21d8915c8afa">   95</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac8a12a60994f2949c63e21d8915c8afa" title="3: opus voice (interactive) ">CODEC_OPUS_VOICE</a>             = 0x04; <span class="comment">//!&lt; 3: opus voice           (interactive)</span></div>
<div class="line"><a name="l00096"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ad86387b6183780d2af6a1918552fc00b">   96</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ad86387b6183780d2af6a1918552fc00b" title="3: opus music (interactive) ">CODEC_OPUS_MUSIC</a>             = 0x05; <span class="comment">//!&lt; 3: opus music           (interactive)</span></div>
<div class="line"><a name="l00097"></a><span class="lineno">   97</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00098"></a><span class="lineno">   98</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00099"></a><span class="lineno">   99</span>&#160;<span class="comment">   * TeamSpeak 3 codec encryption modes.</span></div>
<div class="line"><a name="l00100"></a><span class="lineno">  100</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00101"></a><span class="lineno"><a class="code" href="class_team_speak3.html#af4beb7ff503847abc4d8f00fa4a14929">  101</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#af4beb7ff503847abc4d8f00fa4a14929" title="0: configure per channel ">CODEC_CRYPT_INDIVIDUAL</a>       = 0x00; <span class="comment">//!&lt; 0: configure per channel</span></div>
<div class="line"><a name="l00102"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a204ba3447155504ad79532e02b0047c8">  102</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a204ba3447155504ad79532e02b0047c8" title="1: globally disabled ">CODEC_CRYPT_DISABLED</a>         = 0x01; <span class="comment">//!&lt; 1: globally disabled</span></div>
<div class="line"><a name="l00103"></a><span class="lineno"><a class="code" href="class_team_speak3.html#af264159fd49c066ad3e88b475a168e45">  103</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#af264159fd49c066ad3e88b475a168e45" title="2: globally enabled ">CODEC_CRYPT_ENABLED</a>          = 0x02; <span class="comment">//!&lt; 2: globally enabled</span></div>
<div class="line"><a name="l00104"></a><span class="lineno">  104</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00105"></a><span class="lineno">  105</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00106"></a><span class="lineno">  106</span>&#160;<span class="comment">   * TeamSpeak 3 kick reason types.</span></div>
<div class="line"><a name="l00107"></a><span class="lineno">  107</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00108"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ab6a4d55688e33c16004508fff14c81da">  108</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ab6a4d55688e33c16004508fff14c81da" title="4: kick client from channel ">KICK_CHANNEL</a>                 = 0x04; <span class="comment">//!&lt; 4: kick client from channel</span></div>
<div class="line"><a name="l00109"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae9df1f0980b1d3e9638b3a8084cc5234">  109</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae9df1f0980b1d3e9638b3a8084cc5234" title="5: kick client from server ">KICK_SERVER</a>                  = 0x05; <span class="comment">//!&lt; 5: kick client from server</span></div>
<div class="line"><a name="l00110"></a><span class="lineno">  110</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00111"></a><span class="lineno">  111</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00112"></a><span class="lineno">  112</span>&#160;<span class="comment">   * TeamSpeak 3 text message target modes.</span></div>
<div class="line"><a name="l00113"></a><span class="lineno">  113</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00114"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a1882bc1d9fcbcc353d04d308194010bf">  114</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a1882bc1d9fcbcc353d04d308194010bf" title="1: target is a client ">TEXTMSG_CLIENT</a>               = 0x01; <span class="comment">//!&lt; 1: target is a client</span></div>
<div class="line"><a name="l00115"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a69511dec19c2f8ed1268267f09e88124">  115</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a69511dec19c2f8ed1268267f09e88124" title="2: target is a channel ">TEXTMSG_CHANNEL</a>              = 0x02; <span class="comment">//!&lt; 2: target is a channel</span></div>
<div class="line"><a name="l00116"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a9f1020035b40674a589647e5dc90c95b">  116</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a9f1020035b40674a589647e5dc90c95b" title="3: target is a virtual server ">TEXTMSG_SERVER</a>               = 0x03; <span class="comment">//!&lt; 3: target is a virtual server</span></div>
<div class="line"><a name="l00117"></a><span class="lineno">  117</span>&#160;<span class="comment"></span>  </div>
<div class="line"><a name="l00118"></a><span class="lineno">  118</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00119"></a><span class="lineno">  119</span>&#160;<span class="comment">   * TeamSpeak 3 plugin command target modes.</span></div>
<div class="line"><a name="l00120"></a><span class="lineno">  120</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00121"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a1017b9d565da82a1a360ecd1074ef882">  121</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a1017b9d565da82a1a360ecd1074ef882" title="1: send plugincmd to all clients in current channel ">PLUGINCMD_CHANNEL</a>            = 0x01; <span class="comment">//!&lt; 1: send plugincmd to all clients in current channel</span></div>
<div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a908573c6bc67e85396a4af21972bfeae">  122</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a908573c6bc67e85396a4af21972bfeae" title="2: send plugincmd to all clients on server ">PLUGINCMD_SERVER</a>             = 0x02; <span class="comment">//!&lt; 2: send plugincmd to all clients on server</span></div>
<div class="line"><a name="l00123"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a2bd847d0f20f1d827238304dedaa6b77">  123</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a2bd847d0f20f1d827238304dedaa6b77" title="3: send plugincmd to all given client ids ">PLUGINCMD_CLIENT</a>             = 0x03; <span class="comment">//!&lt; 3: send plugincmd to all given client ids</span></div>
<div class="line"><a name="l00124"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac5519852d33570fbd89e171937f553c2">  124</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac5519852d33570fbd89e171937f553c2" title="4: send plugincmd to all subscribed clients in current channel ">PLUGINCMD_CHANNEL_SUBSCRIBED</a> = 0x04; <span class="comment">//!&lt; 4: send plugincmd to all subscribed clients in current channel</span></div>
<div class="line"><a name="l00125"></a><span class="lineno">  125</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00126"></a><span class="lineno">  126</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00127"></a><span class="lineno">  127</span>&#160;<span class="comment">   * TeamSpeak 3 host message modes.</span></div>
<div class="line"><a name="l00128"></a><span class="lineno">  128</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00129"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a4350e9a5261f832d44d3b416d5bdcb50">  129</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a4350e9a5261f832d44d3b416d5bdcb50" title="0: display no message ">HOSTMSG_NONE</a>                 = 0x00; <span class="comment">//!&lt; 0: display no message</span></div>
<div class="line"><a name="l00130"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a6c155661d55cd61ef79b1fd6413e5880">  130</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a6c155661d55cd61ef79b1fd6413e5880" title="1: display message in chatlog ">HOSTMSG_LOG</a>                  = 0x01; <span class="comment">//!&lt; 1: display message in chatlog</span></div>
<div class="line"><a name="l00131"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7d044183051509b77831a5546748245e">  131</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7d044183051509b77831a5546748245e" title="2: display message in modal dialog ">HOSTMSG_MODAL</a>                = 0x02; <span class="comment">//!&lt; 2: display message in modal dialog</span></div>
<div class="line"><a name="l00132"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ad1956014c2a37cf8883bc6e845991597">  132</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ad1956014c2a37cf8883bc6e845991597" title="3: display message in modal dialog and close connection ">HOSTMSG_MODALQUIT</a>            = 0x03; <span class="comment">//!&lt; 3: display message in modal dialog and close connection</span></div>
<div class="line"><a name="l00133"></a><span class="lineno">  133</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00134"></a><span class="lineno">  134</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00135"></a><span class="lineno">  135</span>&#160;<span class="comment">   * TeamSpeak 3 host banner modes.</span></div>
<div class="line"><a name="l00136"></a><span class="lineno">  136</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00137"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a5a13321bcb3eff4b51cbe56eb342b701">  137</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a5a13321bcb3eff4b51cbe56eb342b701" title="0: do not adjust ">HOSTBANNER_NO_ADJUST</a>         = 0x00; <span class="comment">//!&lt; 0: do not adjust</span></div>
<div class="line"><a name="l00138"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a0948f6a231bacd72d3455adc3314aadb">  138</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a0948f6a231bacd72d3455adc3314aadb" title="1: adjust but ignore aspect ratio ">HOSTBANNER_IGNORE_ASPECT</a>     = 0x01; <span class="comment">//!&lt; 1: adjust but ignore aspect ratio</span></div>
<div class="line"><a name="l00139"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aa9e2a430fd552f4a0c3dec0855a4f8ad">  139</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aa9e2a430fd552f4a0c3dec0855a4f8ad" title="2: adjust and keep aspect ratio ">HOSTBANNER_KEEP_ASPECT</a>       = 0x02; <span class="comment">//!&lt; 2: adjust and keep aspect ratio</span></div>
<div class="line"><a name="l00140"></a><span class="lineno">  140</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00141"></a><span class="lineno">  141</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00142"></a><span class="lineno">  142</span>&#160;<span class="comment">   * TeamSpeak 3 client identification types.</span></div>
<div class="line"><a name="l00143"></a><span class="lineno">  143</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00144"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae2f58969a8868c4793c485d63e6e7f05">  144</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae2f58969a8868c4793c485d63e6e7f05" title="0: regular client ">CLIENT_TYPE_REGULAR</a>          = 0x00; <span class="comment">//!&lt; 0: regular client</span></div>
<div class="line"><a name="l00145"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a3c3b0109548e9a41717d64db57f54b6a">  145</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a3c3b0109548e9a41717d64db57f54b6a" title="1: query client ">CLIENT_TYPE_SERVERQUERY</a>      = 0x01; <span class="comment">//!&lt; 1: query client</span></div>
<div class="line"><a name="l00146"></a><span class="lineno">  146</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00147"></a><span class="lineno">  147</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00148"></a><span class="lineno">  148</span>&#160;<span class="comment">   * TeamSpeak 3 permission group database types.</span></div>
<div class="line"><a name="l00149"></a><span class="lineno">  149</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00150"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aeeab1204791458d7e543aedf5c4c8699">  150</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aeeab1204791458d7e543aedf5c4c8699" title="0: template group (used for new virtual servers) ">GROUP_DBTYPE_TEMPLATE</a>        = 0x00; <span class="comment">//!&lt; 0: template group     (used for new virtual servers)</span></div>
<div class="line"><a name="l00151"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05">  151</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a6e018ed33e01f80861a9649f5fbdcb05" title="1: regular group (used for regular clients) ">GROUP_DBTYPE_REGULAR</a>         = 0x01; <span class="comment">//!&lt; 1: regular group      (used for regular clients)</span></div>
<div class="line"><a name="l00152"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a197a03a9e83e5663d0f071df18fb127d">  152</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a197a03a9e83e5663d0f071df18fb127d" title="2: global query group (used for ServerQuery clients) ">GROUP_DBTYPE_SERVERQUERY</a>     = 0x02; <span class="comment">//!&lt; 2: global query group (used for ServerQuery clients)</span></div>
<div class="line"><a name="l00153"></a><span class="lineno">  153</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00154"></a><span class="lineno">  154</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00155"></a><span class="lineno">  155</span>&#160;<span class="comment">   * TeamSpeak 3 permission group name modes.</span></div>
<div class="line"><a name="l00156"></a><span class="lineno">  156</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00157"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a9bfa984813e9074be19a7cba3a8673d3">  157</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a9bfa984813e9074be19a7cba3a8673d3" title="0: display no name ">GROUP_NAMEMODE_HIDDEN</a>        = 0x00; <span class="comment">//!&lt; 0: display no name</span></div>
<div class="line"><a name="l00158"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac9179c4a74a5c0cd269e6639868f3b57">  158</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac9179c4a74a5c0cd269e6639868f3b57" title="1: display name before client nickname ">GROUP_NAMEMODE_BEFORE</a>        = 0x01; <span class="comment">//!&lt; 1: display name before client nickname</span></div>
<div class="line"><a name="l00159"></a><span class="lineno"><a class="code" href="class_team_speak3.html#af93218df38a498fd730ad2f2676f6567">  159</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#af93218df38a498fd730ad2f2676f6567" title="2: display name after client nickname ">GROUP_NAMEMODE_BEHIND</a>        = 0x02; <span class="comment">//!&lt; 2: display name after client nickname</span></div>
<div class="line"><a name="l00160"></a><span class="lineno">  160</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00161"></a><span class="lineno">  161</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00162"></a><span class="lineno">  162</span>&#160;<span class="comment">   * TeamSpeak 3 permission group identification types.</span></div>
<div class="line"><a name="l00163"></a><span class="lineno">  163</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00164"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac8dbaaf31bc8b339287692ae80abae94">  164</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac8dbaaf31bc8b339287692ae80abae94" title="1: identify most powerful group ">GROUP_IDENTIFIY_STRONGEST</a>    = 0x01; <span class="comment">//!&lt; 1: identify most powerful group</span></div>
<div class="line"><a name="l00165"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7e2d5457e1faace304311ca1617c283b">  165</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7e2d5457e1faace304311ca1617c283b" title="2: identify weakest group ">GROUP_IDENTIFIY_WEAKEST</a>      = 0x02; <span class="comment">//!&lt; 2: identify weakest group</span></div>
<div class="line"><a name="l00166"></a><span class="lineno">  166</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00167"></a><span class="lineno">  167</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00168"></a><span class="lineno">  168</span>&#160;<span class="comment">   * TeamSpeak 3 permission types.</span></div>
<div class="line"><a name="l00169"></a><span class="lineno">  169</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00170"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a0772e3a79ac03d3acb657e07dad63a0e">  170</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a0772e3a79ac03d3acb657e07dad63a0e" title="0: server group permission ">PERM_TYPE_SERVERGROUP</a>        = 0x00; <span class="comment">//!&lt; 0: server group permission</span></div>
<div class="line"><a name="l00171"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a9ea90147fb0486786931015e4d64abba">  171</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a9ea90147fb0486786931015e4d64abba" title="1: client specific permission ">PERM_TYPE_CLIENT</a>             = 0x01; <span class="comment">//!&lt; 1: client specific permission</span></div>
<div class="line"><a name="l00172"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a57fa7853513872a96f0adf9d3329c59b">  172</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a57fa7853513872a96f0adf9d3329c59b" title="2: channel specific permission ">PERM_TYPE_CHANNEL</a>            = 0x02; <span class="comment">//!&lt; 2: channel specific permission</span></div>
<div class="line"><a name="l00173"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a2a930337bd67c2c2893b3afad902b440">  173</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a2a930337bd67c2c2893b3afad902b440" title="3: channel group permission ">PERM_TYPE_CHANNELGROUP</a>       = 0x03; <span class="comment">//!&lt; 3: channel group permission</span></div>
<div class="line"><a name="l00174"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a5324e065c2ed9c98c0931654d388610f">  174</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a5324e065c2ed9c98c0931654d388610f" title="4: channel-client specific permission ">PERM_TYPE_CHANNELCLIENT</a>      = 0x04; <span class="comment">//!&lt; 4: channel-client specific permission</span></div>
<div class="line"><a name="l00175"></a><span class="lineno">  175</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00176"></a><span class="lineno">  176</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00177"></a><span class="lineno">  177</span>&#160;<span class="comment">   * TeamSpeak 3 permission categories.</span></div>
<div class="line"><a name="l00178"></a><span class="lineno">  178</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00179"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aa5aba89a9024b4e7c7845b115f8e9c40">  179</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aa5aba89a9024b4e7c7845b115f8e9c40" title="00010000: global permissions ">PERM_CAT_GLOBAL</a>              = 0x10; <span class="comment">//!&lt; 00010000: global permissions</span></div>
<div class="line"><a name="l00180"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac1329c48f57dcee568be69b33c778c99">  180</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac1329c48f57dcee568be69b33c778c99" title="00010001: global permissions -&gt; global information ">PERM_CAT_GLOBAL_INFORMATION</a>  = 0x11; <span class="comment">//!&lt; 00010001: global permissions -&gt; global information</span></div>
<div class="line"><a name="l00181"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a0f7b0579cd636c1ea7fe5bcdd92dbc09">  181</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a0f7b0579cd636c1ea7fe5bcdd92dbc09" title="00010010: global permissions -&gt; virtual server management ">PERM_CAT_GLOBAL_SERVER_MGMT</a>  = 0x12; <span class="comment">//!&lt; 00010010: global permissions -&gt; virtual server management</span></div>
<div class="line"><a name="l00182"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a4fa166aef3d0ba5f2204d8b9a257a23b">  182</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a4fa166aef3d0ba5f2204d8b9a257a23b" title="00010011: global permissions -&gt; global administrative actions ">PERM_CAT_GLOBAL_ADM_ACTIONS</a>  = 0x13; <span class="comment">//!&lt; 00010011: global permissions -&gt; global administrative actions</span></div>
<div class="line"><a name="l00183"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a5d9945d86f2ab5f1a4934e2604652503">  183</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a5d9945d86f2ab5f1a4934e2604652503" title="00010100: global permissions -&gt; global settings ">PERM_CAT_GLOBAL_SETTINGS</a>     = 0x14; <span class="comment">//!&lt; 00010100: global permissions -&gt; global settings</span></div>
<div class="line"><a name="l00184"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aa639ddfd900cc55961633d2e3ca03168">  184</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aa639ddfd900cc55961633d2e3ca03168" title="00100000: virtual server permissions ">PERM_CAT_SERVER</a>              = 0x20; <span class="comment">//!&lt; 00100000: virtual server permissions</span></div>
<div class="line"><a name="l00185"></a><span class="lineno"><a class="code" href="class_team_speak3.html#adab57311071c4b74b2f221dd747d9f54">  185</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#adab57311071c4b74b2f221dd747d9f54" title="00100001: virtual server permissions -&gt; virtual server information ">PERM_CAT_SERVER_INFORMATION</a>  = 0x21; <span class="comment">//!&lt; 00100001: virtual server permissions -&gt; virtual server information</span></div>
<div class="line"><a name="l00186"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a2237bc5075c3c354764e42f40a045179">  186</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a2237bc5075c3c354764e42f40a045179" title="00100010: virtual server permissions -&gt; virtual server administrative actions ">PERM_CAT_SERVER_ADM_ACTIONS</a>  = 0x22; <span class="comment">//!&lt; 00100010: virtual server permissions -&gt; virtual server administrative actions</span></div>
<div class="line"><a name="l00187"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a6dd546e23743326565a82accf7d793f6">  187</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a6dd546e23743326565a82accf7d793f6" title="00100011: virtual server permissions -&gt; virtual server settings ">PERM_CAT_SERVER_SETTINGS</a>     = 0x23; <span class="comment">//!&lt; 00100011: virtual server permissions -&gt; virtual server settings</span></div>
<div class="line"><a name="l00188"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a0f7b54be70a8c790115ca92e98bcbee5">  188</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a0f7b54be70a8c790115ca92e98bcbee5" title="00110000: channel permissions ">PERM_CAT_CHANNEL</a>             = 0x30; <span class="comment">//!&lt; 00110000: channel permissions</span></div>
<div class="line"><a name="l00189"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae70bc3d695fcfe6db61c86fb58c076bd">  189</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae70bc3d695fcfe6db61c86fb58c076bd" title="00110001: channel permissions -&gt; channel information ">PERM_CAT_CHANNEL_INFORMATION</a> = 0x31; <span class="comment">//!&lt; 00110001: channel permissions -&gt; channel information</span></div>
<div class="line"><a name="l00190"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aff66f6e403b88244a46c5cddefd63853">  190</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aff66f6e403b88244a46c5cddefd63853" title="00110010: channel permissions -&gt; create channels ">PERM_CAT_CHANNEL_CREATE</a>      = 0x32; <span class="comment">//!&lt; 00110010: channel permissions -&gt; create channels</span></div>
<div class="line"><a name="l00191"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a511bfe0b317d488a475c044baf3e490a">  191</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a511bfe0b317d488a475c044baf3e490a" title="00110011: channel permissions -&gt; edit channels ">PERM_CAT_CHANNEL_MODIFY</a>      = 0x33; <span class="comment">//!&lt; 00110011: channel permissions -&gt; edit channels</span></div>
<div class="line"><a name="l00192"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a2615a76afeecf68eae3ba5f2e908373c">  192</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a2615a76afeecf68eae3ba5f2e908373c" title="00110100: channel permissions -&gt; delete channels ">PERM_CAT_CHANNEL_DELETE</a>      = 0x34; <span class="comment">//!&lt; 00110100: channel permissions -&gt; delete channels</span></div>
<div class="line"><a name="l00193"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac3b12e51946589138a84fdf2c653c9f6">  193</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac3b12e51946589138a84fdf2c653c9f6" title="00110101: channel permissions -&gt; access channels ">PERM_CAT_CHANNEL_ACCESS</a>      = 0x35; <span class="comment">//!&lt; 00110101: channel permissions -&gt; access channels</span></div>
<div class="line"><a name="l00194"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a8cd0b0d4c26e955f67be448039c4a4e2">  194</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a8cd0b0d4c26e955f67be448039c4a4e2" title="01000000: group permissions ">PERM_CAT_GROUP</a>               = 0x40; <span class="comment">//!&lt; 01000000: group permissions</span></div>
<div class="line"><a name="l00195"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aec5b4d0b149798108c05580399923757">  195</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aec5b4d0b149798108c05580399923757" title="01000001: group permissions -&gt; group information ">PERM_CAT_GROUP_INFORMATION</a>   = 0x41; <span class="comment">//!&lt; 01000001: group permissions -&gt; group information</span></div>
<div class="line"><a name="l00196"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ab413bc7287c76152eb9c51a74385b8a5">  196</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ab413bc7287c76152eb9c51a74385b8a5" title="01000010: group permissions -&gt; create groups ">PERM_CAT_GROUP_CREATE</a>        = 0x42; <span class="comment">//!&lt; 01000010: group permissions -&gt; create groups</span></div>
<div class="line"><a name="l00197"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aae3f41d88cbf9fbadb9f38dd67027168">  197</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aae3f41d88cbf9fbadb9f38dd67027168" title="01000011: group permissions -&gt; edit groups ">PERM_CAT_GROUP_MODIFY</a>        = 0x43; <span class="comment">//!&lt; 01000011: group permissions -&gt; edit groups</span></div>
<div class="line"><a name="l00198"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a2d89a707e37e81732d9e9ba827cd8dd5">  198</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a2d89a707e37e81732d9e9ba827cd8dd5" title="01000100: group permissions -&gt; delete groups ">PERM_CAT_GROUP_DELETE</a>        = 0x44; <span class="comment">//!&lt; 01000100: group permissions -&gt; delete groups</span></div>
<div class="line"><a name="l00199"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a47cc2fc667c048d716b054b21ccba9c0">  199</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a47cc2fc667c048d716b054b21ccba9c0" title="01010000: client permissions ">PERM_CAT_CLIENT</a>              = 0x50; <span class="comment">//!&lt; 01010000: client permissions</span></div>
<div class="line"><a name="l00200"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a745423668d892edf35aff2dc1d802649">  200</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a745423668d892edf35aff2dc1d802649" title="01010001: client permissions -&gt; client information ">PERM_CAT_CLIENT_INFORMATION</a>  = 0x51; <span class="comment">//!&lt; 01010001: client permissions -&gt; client information</span></div>
<div class="line"><a name="l00201"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aab7ee7ef3548dce162310f5b58e22bce">  201</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aab7ee7ef3548dce162310f5b58e22bce" title="01010010: client permissions -&gt; client administrative actions ">PERM_CAT_CLIENT_ADM_ACTIONS</a>  = 0x52; <span class="comment">//!&lt; 01010010: client permissions -&gt; client administrative actions</span></div>
<div class="line"><a name="l00202"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ab5e4b438da7c292ea5985eed88396f4d">  202</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ab5e4b438da7c292ea5985eed88396f4d" title="01010011: client permissions -&gt; client basic communication ">PERM_CAT_CLIENT_BASICS</a>       = 0x53; <span class="comment">//!&lt; 01010011: client permissions -&gt; client basic communication</span></div>
<div class="line"><a name="l00203"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a36c30eb13e8fe039e4c06a45e3e5f35a">  203</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a36c30eb13e8fe039e4c06a45e3e5f35a" title="01010100: client permissions -&gt; edit clients ">PERM_CAT_CLIENT_MODIFY</a>       = 0x54; <span class="comment">//!&lt; 01010100: client permissions -&gt; edit clients</span></div>
<div class="line"><a name="l00204"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a1fa36fce856fa4d8ee9af0d2147d398a">  204</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a1fa36fce856fa4d8ee9af0d2147d398a" title="01100000: file transfer permissions ">PERM_CAT_FILETRANSFER</a>        = 0x60; <span class="comment">//!&lt; 01100000: file transfer permissions</span></div>
<div class="line"><a name="l00205"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aa534b78937197a0a0739f1fa3c98a8d1">  205</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aa534b78937197a0a0739f1fa3c98a8d1" title="11111111: needed permission modify power (grant) permissions ">PERM_CAT_NEEDED_MODIFY_POWER</a> = 0xFF; <span class="comment">//!&lt; 11111111: needed permission modify power (grant) permissions</span></div>
<div class="line"><a name="l00206"></a><span class="lineno">  206</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00207"></a><span class="lineno">  207</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00208"></a><span class="lineno">  208</span>&#160;<span class="comment">   * TeamSpeak 3 file types.</span></div>
<div class="line"><a name="l00209"></a><span class="lineno">  209</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00210"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a0dfea6a5fe76141895e0f2900e8e4e52">  210</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a0dfea6a5fe76141895e0f2900e8e4e52" title="0: file is directory ">FILE_TYPE_DIRECTORY</a>          = 0x00; <span class="comment">//!&lt; 0: file is directory</span></div>
<div class="line"><a name="l00211"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aec926b29e75ca080eb7fb8fbf69f9ab9">  211</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aec926b29e75ca080eb7fb8fbf69f9ab9" title="1: file is regular ">FILE_TYPE_REGULAR</a>            = 0x01; <span class="comment">//!&lt; 1: file is regular</span></div>
<div class="line"><a name="l00212"></a><span class="lineno">  212</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00213"></a><span class="lineno">  213</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00214"></a><span class="lineno">  214</span>&#160;<span class="comment">   * TeamSpeak 3 server snapshot types.</span></div>
<div class="line"><a name="l00215"></a><span class="lineno">  215</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00216"></a><span class="lineno"><a class="code" href="class_team_speak3.html#af9a20a17b3aaaf60621e4f471f7e300a">  216</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#af9a20a17b3aaaf60621e4f471f7e300a" title="0: default string ">SNAPSHOT_STRING</a>              = 0x00; <span class="comment">//!&lt; 0: default string</span></div>
<div class="line"><a name="l00217"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac9535ce5e98c480aea71d0f149a7c2cb">  217</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac9535ce5e98c480aea71d0f149a7c2cb" title="1: base64 string ">SNAPSHOT_BASE64</a>              = 0x01; <span class="comment">//!&lt; 1: base64 string</span></div>
<div class="line"><a name="l00218"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7dfffb36f25a89a472b60275fc3fc4e7">  218</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7dfffb36f25a89a472b60275fc3fc4e7" title="2: hexadecimal string ">SNAPSHOT_HEXDEC</a>              = 0x02; <span class="comment">//!&lt; 2: hexadecimal string</span></div>
<div class="line"><a name="l00219"></a><span class="lineno">  219</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00220"></a><span class="lineno">  220</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00221"></a><span class="lineno">  221</span>&#160;<span class="comment">   * TeamSpeak 3 channel spacer types.</span></div>
<div class="line"><a name="l00222"></a><span class="lineno">  222</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00223"></a><span class="lineno"><a class="code" href="class_team_speak3.html#abe21c7855096b6b8d86613897ed1a4bd">  223</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#abe21c7855096b6b8d86613897ed1a4bd" title="0: solid line ">SPACER_SOLIDLINE</a>             = 0x00; <span class="comment">//!&lt; 0: solid line</span></div>
<div class="line"><a name="l00224"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae0f64ba57dfa729092ae07f0508ad20c">  224</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae0f64ba57dfa729092ae07f0508ad20c" title="1: dash line ">SPACER_DASHLINE</a>              = 0x01; <span class="comment">//!&lt; 1: dash line</span></div>
<div class="line"><a name="l00225"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a1b97ddf3ea3bfb3bac4167cc9853bcf5">  225</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a1b97ddf3ea3bfb3bac4167cc9853bcf5" title="2: dot line ">SPACER_DOTLINE</a>               = 0x02; <span class="comment">//!&lt; 2: dot line</span></div>
<div class="line"><a name="l00226"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ab5f7f692edb611a09be65dbe1cc22fd3">  226</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ab5f7f692edb611a09be65dbe1cc22fd3" title="3: dash dot line ">SPACER_DASHDOTLINE</a>           = 0x03; <span class="comment">//!&lt; 3: dash dot line</span></div>
<div class="line"><a name="l00227"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a8a46203c06bf7b769b1245eee8c71eca">  227</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a8a46203c06bf7b769b1245eee8c71eca" title="4: dash dot dot line ">SPACER_DASHDOTDOTLINE</a>        = 0x04; <span class="comment">//!&lt; 4: dash dot dot line</span></div>
<div class="line"><a name="l00228"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a12e9d78448fe9a2fc19f71a19db33b24">  228</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a12e9d78448fe9a2fc19f71a19db33b24" title="5: custom format ">SPACER_CUSTOM</a>                = 0x05; <span class="comment">//!&lt; 5: custom format</span></div>
<div class="line"><a name="l00229"></a><span class="lineno">  229</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00230"></a><span class="lineno">  230</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00231"></a><span class="lineno">  231</span>&#160;<span class="comment">   * TeamSpeak 3 channel spacer alignments.</span></div>
<div class="line"><a name="l00232"></a><span class="lineno">  232</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00233"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ad7a9fe53817b1d8441eafe1cfed2570e">  233</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ad7a9fe53817b1d8441eafe1cfed2570e" title="0: alignment left ">SPACER_ALIGN_LEFT</a>            = 0x00; <span class="comment">//!&lt; 0: alignment left</span></div>
<div class="line"><a name="l00234"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ace570a7b5abdbfd89f20145f2757bbcd">  234</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ace570a7b5abdbfd89f20145f2757bbcd" title="1: alignment right ">SPACER_ALIGN_RIGHT</a>           = 0x01; <span class="comment">//!&lt; 1: alignment right</span></div>
<div class="line"><a name="l00235"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aaffe4f52d9d9009a8fd90fb2683e18ce">  235</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aaffe4f52d9d9009a8fd90fb2683e18ce" title="2: alignment center ">SPACER_ALIGN_CENTER</a>          = 0x02; <span class="comment">//!&lt; 2: alignment center</span></div>
<div class="line"><a name="l00236"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7aa076becfafe9cfb5a6b9eae4c72831">  236</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7aa076becfafe9cfb5a6b9eae4c72831" title="3: repeat until the whole line is filled ">SPACER_ALIGN_REPEAT</a>          = 0x03; <span class="comment">//!&lt; 3: repeat until the whole line is filled</span></div>
<div class="line"><a name="l00237"></a><span class="lineno">  237</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00238"></a><span class="lineno">  238</span>&#160;  <span class="comment">/*@</span></div>
<div class="line"><a name="l00239"></a><span class="lineno">  239</span>&#160;<span class="comment">   * TeamSpeak 3 reason identifiers.</span></div>
<div class="line"><a name="l00240"></a><span class="lineno">  240</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00241"></a><span class="lineno"><a class="code" href="class_team_speak3.html#afb77656b36c45073e770f13bf0a90e5d">  241</a></span>&#160;  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#afb77656b36c45073e770f13bf0a90e5d" title="0: no reason ">REASON_NONE</a>                  = 0x00; <span class="comment">//!&lt;  0: no reason</span></div>
<div class="line"><a name="l00242"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aad9bd5c1089efa20620cab286052b0f3">  242</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aad9bd5c1089efa20620cab286052b0f3" title="1: channel switched or moved ">REASON_MOVE</a>                  = 0x01; <span class="comment">//!&lt;  1: channel switched or moved</span></div>
<div class="line"><a name="l00243"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a328b7a4eeed0ecd61865be986aa79f9c">  243</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a328b7a4eeed0ecd61865be986aa79f9c" title="2: subscription added or removed ">REASON_SUBSCRIPTION</a>          = 0x02; <span class="comment">//!&lt;  2: subscription added or removed</span></div>
<div class="line"><a name="l00244"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aea8db94828ad856d0a207d228145e41a">  244</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#aea8db94828ad856d0a207d228145e41a" title="3: client connection timed out ">REASON_TIMEOUT</a>               = 0x03; <span class="comment">//!&lt;  3: client connection timed out</span></div>
<div class="line"><a name="l00245"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a3c394288b3b45df4a039127d1e119517">  245</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a3c394288b3b45df4a039127d1e119517" title="4: client kicked from channel ">REASON_CHANNEL_KICK</a>          = 0x04; <span class="comment">//!&lt;  4: client kicked from channel</span></div>
<div class="line"><a name="l00246"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a931e59afb66273ee4255e43676812726">  246</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a931e59afb66273ee4255e43676812726" title="5: client kicked from server ">REASON_SERVER_KICK</a>           = 0x05; <span class="comment">//!&lt;  5: client kicked from server</span></div>
<div class="line"><a name="l00247"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ad9dc7ed023c1a9be4504ba894a63bee1">  247</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ad9dc7ed023c1a9be4504ba894a63bee1" title="6: client banned from server ">REASON_SERVER_BAN</a>            = 0x06; <span class="comment">//!&lt;  6: client banned from server</span></div>
<div class="line"><a name="l00248"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ac48ef3e11414170eecffcd252a637062">  248</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ac48ef3e11414170eecffcd252a637062" title="7: server stopped ">REASON_SERVER_STOP</a>           = 0x07; <span class="comment">//!&lt;  7: server stopped</span></div>
<div class="line"><a name="l00249"></a><span class="lineno"><a class="code" href="class_team_speak3.html#ae10cf1e6e6a365cf61eb7e38f6a2315b">  249</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#ae10cf1e6e6a365cf61eb7e38f6a2315b" title="8: client disconnected ">REASON_DISCONNECT</a>            = 0x08; <span class="comment">//!&lt;  8: client disconnected</span></div>
<div class="line"><a name="l00250"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a7d82c5b03e862e2f53313363e1423535">  250</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a7d82c5b03e862e2f53313363e1423535" title="9: channel information updated ">REASON_CHANNEL_UPDATE</a>        = 0x09; <span class="comment">//!&lt;  9: channel information updated</span></div>
<div class="line"><a name="l00251"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a47403f14dad07252a387b8cc7e5d816f">  251</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a47403f14dad07252a387b8cc7e5d816f" title="10: channel information edited ">REASON_CHANNEL_EDIT</a>          = 0x0A; <span class="comment">//!&lt; 10: channel information edited</span></div>
<div class="line"><a name="l00252"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a9dcf492812b8b16ffbebcd05ffa1e6bf">  252</a></span>&#160;<span class="comment"></span>  <span class="keyword">const</span> <a class="code" href="class_team_speak3.html#a9dcf492812b8b16ffbebcd05ffa1e6bf" title="11: client disconnected on server shutdown ">REASON_DISCONNECT_SHUTDOWN</a>   = 0x0B; <span class="comment">//!&lt; 11: client disconnected on server shutdown</span></div>
<div class="line"><a name="l00253"></a><span class="lineno">  253</span>&#160;<span class="comment"></span><span class="comment"></span></div>
<div class="line"><a name="l00254"></a><span class="lineno">  254</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00255"></a><span class="lineno">  255</span>&#160;<span class="comment">   * Stores an array containing various chars which need to be escaped while communicating</span></div>
<div class="line"><a name="l00256"></a><span class="lineno">  256</span>&#160;<span class="comment">   * with a TeamSpeak 3 Server.</span></div>
<div class="line"><a name="l00257"></a><span class="lineno">  257</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00258"></a><span class="lineno">  258</span>&#160;<span class="comment">   * @var array</span></div>
<div class="line"><a name="l00259"></a><span class="lineno">  259</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00260"></a><span class="lineno">  260</span>&#160;  <span class="keyword">protected</span> <span class="keyword">static</span> $escape_patterns = array(</div>
<div class="line"><a name="l00261"></a><span class="lineno">  261</span>&#160;    <span class="stringliteral">&quot;\\&quot;</span> =&gt; <span class="stringliteral">&quot;\\\\&quot;</span>, <span class="comment">// backslash</span></div>
<div class="line"><a name="l00262"></a><span class="lineno">  262</span>&#160;    <span class="stringliteral">&quot;/&quot;</span>  =&gt; <span class="stringliteral">&quot;\\/&quot;</span>,  <span class="comment">// slash</span></div>
<div class="line"><a name="l00263"></a><span class="lineno">  263</span>&#160;    <span class="stringliteral">&quot; &quot;</span>  =&gt; <span class="stringliteral">&quot;\\s&quot;</span>,  <span class="comment">// whitespace</span></div>
<div class="line"><a name="l00264"></a><span class="lineno">  264</span>&#160;    <span class="stringliteral">&quot;|&quot;</span>  =&gt; <span class="stringliteral">&quot;\\p&quot;</span>,  <span class="comment">// pipe</span></div>
<div class="line"><a name="l00265"></a><span class="lineno">  265</span>&#160;    <span class="stringliteral">&quot;;&quot;</span>  =&gt; <span class="stringliteral">&quot;\\;&quot;</span>,  <span class="comment">// semicolon</span></div>
<div class="line"><a name="l00266"></a><span class="lineno">  266</span>&#160;    <span class="stringliteral">&quot;\a&quot;</span> =&gt; <span class="stringliteral">&quot;\\a&quot;</span>,  <span class="comment">// bell</span></div>
<div class="line"><a name="l00267"></a><span class="lineno">  267</span>&#160;    <span class="stringliteral">&quot;\b&quot;</span> =&gt; <span class="stringliteral">&quot;\\b&quot;</span>,  <span class="comment">// backspace</span></div>
<div class="line"><a name="l00268"></a><span class="lineno">  268</span>&#160;    <span class="stringliteral">&quot;\f&quot;</span> =&gt; <span class="stringliteral">&quot;\\f&quot;</span>,  <span class="comment">// formfeed</span></div>
<div class="line"><a name="l00269"></a><span class="lineno">  269</span>&#160;    <span class="stringliteral">&quot;\n&quot;</span> =&gt; <span class="stringliteral">&quot;\\n&quot;</span>,  <span class="comment">// newline</span></div>
<div class="line"><a name="l00270"></a><span class="lineno">  270</span>&#160;    <span class="stringliteral">&quot;\r&quot;</span> =&gt; <span class="stringliteral">&quot;\\r&quot;</span>,  <span class="comment">// carriage return</span></div>
<div class="line"><a name="l00271"></a><span class="lineno">  271</span>&#160;    <span class="stringliteral">&quot;\t&quot;</span> =&gt; <span class="stringliteral">&quot;\\t&quot;</span>,  <span class="comment">// horizontal tab</span></div>
<div class="line"><a name="l00272"></a><span class="lineno">  272</span>&#160;    <span class="stringliteral">&quot;\v&quot;</span> =&gt; <span class="stringliteral">&quot;\\v&quot;</span>   <span class="comment">// vertical tab</span></div>
<div class="line"><a name="l00273"></a><span class="lineno">  273</span>&#160;  );</div>
<div class="line"><a name="l00274"></a><span class="lineno">  274</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00275"></a><span class="lineno">  275</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00276"></a><span class="lineno">  276</span>&#160;<span class="comment">   * Factory for TeamSpeak3_Adapter_Abstract classes. $uri must be formatted as</span></div>
<div class="line"><a name="l00277"></a><span class="lineno">  277</span>&#160;<span class="comment">   * &quot;&lt;adapter&gt;://&lt;user&gt;:&lt;pass&gt;@&lt;host&gt;:&lt;port&gt;/&lt;options&gt;#&lt;flags&gt;&quot;. All parameters</span></div>
<div class="line"><a name="l00278"></a><span class="lineno">  278</span>&#160;<span class="comment">   * except adapter, host and port are optional.</span></div>
<div class="line"><a name="l00279"></a><span class="lineno">  279</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00280"></a><span class="lineno">  280</span>&#160;<span class="comment">   * === Supported Options ===</span></div>
<div class="line"><a name="l00281"></a><span class="lineno">  281</span>&#160;<span class="comment">   *   - timeout</span></div>
<div class="line"><a name="l00282"></a><span class="lineno">  282</span>&#160;<span class="comment">   *   - blocking</span></div>
<div class="line"><a name="l00283"></a><span class="lineno">  283</span>&#160;<span class="comment">   *   - nickname</span></div>
<div class="line"><a name="l00284"></a><span class="lineno">  284</span>&#160;<span class="comment">   *   - no_query_clients</span></div>
<div class="line"><a name="l00285"></a><span class="lineno">  285</span>&#160;<span class="comment">   *   - use_offline_as_virtual</span></div>
<div class="line"><a name="l00286"></a><span class="lineno">  286</span>&#160;<span class="comment">   *   - clients_before_channels</span></div>
<div class="line"><a name="l00287"></a><span class="lineno">  287</span>&#160;<span class="comment">   *   - server_id|server_uid|server_port|server_name|server_tsdns</span></div>
<div class="line"><a name="l00288"></a><span class="lineno">  288</span>&#160;<span class="comment">   *   - channel_id|channel_name</span></div>
<div class="line"><a name="l00289"></a><span class="lineno">  289</span>&#160;<span class="comment">   *   - client_id|client_uid|client_name</span></div>
<div class="line"><a name="l00290"></a><span class="lineno">  290</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00291"></a><span class="lineno">  291</span>&#160;<span class="comment">   * === Supported Flags (only one per $uri) ===</span></div>
<div class="line"><a name="l00292"></a><span class="lineno">  292</span>&#160;<span class="comment">   *   - no_query_clients</span></div>
<div class="line"><a name="l00293"></a><span class="lineno">  293</span>&#160;<span class="comment">   *   - use_offline_as_virtual</span></div>
<div class="line"><a name="l00294"></a><span class="lineno">  294</span>&#160;<span class="comment">   *   - clients_before_channels</span></div>
<div class="line"><a name="l00295"></a><span class="lineno">  295</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00296"></a><span class="lineno">  296</span>&#160;<span class="comment">   * === URI Examples ===</span></div>
<div class="line"><a name="l00297"></a><span class="lineno">  297</span>&#160;<span class="comment">   *   - serverquery://127.0.0.1:10011/</span></div>
<div class="line"><a name="l00298"></a><span class="lineno">  298</span>&#160;<span class="comment">   *   - serverquery://127.0.0.1:10011/?server_port=9987&amp;channel_id=1</span></div>
<div class="line"><a name="l00299"></a><span class="lineno">  299</span>&#160;<span class="comment">   *   - serverquery://127.0.0.1:10011/?server_port=9987&amp;channel_id=1#no_query_clients</span></div>
<div class="line"><a name="l00300"></a><span class="lineno">  300</span>&#160;<span class="comment">   *   - serverquery://127.0.0.1:10011/?server_port=9987&amp;client_name=ScP</span></div>
<div class="line"><a name="l00301"></a><span class="lineno">  301</span>&#160;<span class="comment">   *   - filetransfer://127.0.0.1:30011/</span></div>
<div class="line"><a name="l00302"></a><span class="lineno">  302</span>&#160;<span class="comment">   *   - blacklist</span></div>
<div class="line"><a name="l00303"></a><span class="lineno">  303</span>&#160;<span class="comment">   *   - update</span></div>
<div class="line"><a name="l00304"></a><span class="lineno">  304</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00305"></a><span class="lineno">  305</span>&#160;<span class="comment">   * @param  string $uri</span></div>
<div class="line"><a name="l00306"></a><span class="lineno">  306</span>&#160;<span class="comment">   * @return TeamSpeak3_Adapter_Abstract</span></div>
<div class="line"><a name="l00307"></a><span class="lineno">  307</span>&#160;<span class="comment">   * @return TeamSpeak3_Node_Abstract</span></div>
<div class="line"><a name="l00308"></a><span class="lineno">  308</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00309"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aed403cdb559cae556a94a0d9823bcaf4">  309</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#aed403cdb559cae556a94a0d9823bcaf4" title="Factory for TeamSpeak3_Adapter_Abstract classes. ">factory</a>($uri)</div>
<div class="line"><a name="l00310"></a><span class="lineno">  310</span>&#160;  {</div>
<div class="line"><a name="l00311"></a><span class="lineno">  311</span>&#160;    self::init();</div>
<div class="line"><a name="l00312"></a><span class="lineno">  312</span>&#160;</div>
<div class="line"><a name="l00313"></a><span class="lineno">  313</span>&#160;    $uri = <span class="keyword">new</span> <a class="code" href="class_team_speak3___helper___uri.html" title="Helper class for URI handling. ">TeamSpeak3_Helper_Uri</a>($uri);</div>
<div class="line"><a name="l00314"></a><span class="lineno">  314</span>&#160;</div>
<div class="line"><a name="l00315"></a><span class="lineno">  315</span>&#160;    $adapter = self::getAdapterName($uri-&gt;getScheme());</div>
<div class="line"><a name="l00316"></a><span class="lineno">  316</span>&#160;    $options = array(<span class="stringliteral">&quot;host&quot;</span> =&gt; $uri-&gt;getHost(), <span class="stringliteral">&quot;port&quot;</span> =&gt; $uri-&gt;getPort(), <span class="stringliteral">&quot;timeout&quot;</span> =&gt; intval($uri-&gt;getQueryVar(<span class="stringliteral">&quot;timeout&quot;</span>, 10)), <span class="stringliteral">&quot;blocking&quot;</span> =&gt; intval($uri-&gt;getQueryVar(<span class="stringliteral">&quot;blocking&quot;</span>, 1)));</div>
<div class="line"><a name="l00317"></a><span class="lineno">  317</span>&#160;</div>
<div class="line"><a name="l00318"></a><span class="lineno">  318</span>&#160;    self::loadClass($adapter);</div>
<div class="line"><a name="l00319"></a><span class="lineno">  319</span>&#160;</div>
<div class="line"><a name="l00320"></a><span class="lineno">  320</span>&#160;    $object = <span class="keyword">new</span> $adapter($options);</div>
<div class="line"><a name="l00321"></a><span class="lineno">  321</span>&#160;</div>
<div class="line"><a name="l00322"></a><span class="lineno">  322</span>&#160;    <span class="keywordflow">if</span>($object instanceof <a class="code" href="class_team_speak3___adapter___server_query.html" title="Provides low-level methods for ServerQuery communication with a TeamSpeak 3 Server. ">TeamSpeak3_Adapter_ServerQuery</a>)</div>
<div class="line"><a name="l00323"></a><span class="lineno">  323</span>&#160;    {</div>
<div class="line"><a name="l00324"></a><span class="lineno">  324</span>&#160;      $node = $object-&gt;getHost();</div>
<div class="line"><a name="l00325"></a><span class="lineno">  325</span>&#160;</div>
<div class="line"><a name="l00326"></a><span class="lineno">  326</span>&#160;      <span class="keywordflow">if</span>($uri-&gt;hasUser() &amp;&amp; $uri-&gt;hasPass())</div>
<div class="line"><a name="l00327"></a><span class="lineno">  327</span>&#160;      {</div>
<div class="line"><a name="l00328"></a><span class="lineno">  328</span>&#160;        $node-&gt;login($uri-&gt;getUser(), $uri-&gt;getPass());</div>
<div class="line"><a name="l00329"></a><span class="lineno">  329</span>&#160;      }</div>
<div class="line"><a name="l00330"></a><span class="lineno">  330</span>&#160;</div>
<div class="line"><a name="l00331"></a><span class="lineno">  331</span>&#160;      <span class="comment">/* option to pre-define nickname */</span></div>
<div class="line"><a name="l00332"></a><span class="lineno">  332</span>&#160;      <span class="keywordflow">if</span>($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;nickname&quot;</span>))</div>
<div class="line"><a name="l00333"></a><span class="lineno">  333</span>&#160;      {</div>
<div class="line"><a name="l00334"></a><span class="lineno">  334</span>&#160;        $node-&gt;setPredefinedQueryName($uri-&gt;getQueryVar(<span class="stringliteral">&quot;nickname&quot;</span>));</div>
<div class="line"><a name="l00335"></a><span class="lineno">  335</span>&#160;      }</div>
<div class="line"><a name="l00336"></a><span class="lineno">  336</span>&#160;</div>
<div class="line"><a name="l00337"></a><span class="lineno">  337</span>&#160;      <span class="comment">/* flag to use offline servers in virtual mode */</span></div>
<div class="line"><a name="l00338"></a><span class="lineno">  338</span>&#160;      <span class="keywordflow">if</span>($uri-&gt;getFragment() == <span class="stringliteral">&quot;use_offline_as_virtual&quot;</span>)</div>
<div class="line"><a name="l00339"></a><span class="lineno">  339</span>&#160;      {</div>
<div class="line"><a name="l00340"></a><span class="lineno">  340</span>&#160;        $node-&gt;setUseOfflineAsVirtual(TRUE);</div>
<div class="line"><a name="l00341"></a><span class="lineno">  341</span>&#160;      }</div>
<div class="line"><a name="l00342"></a><span class="lineno">  342</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;use_offline_as_virtual&quot;</span>))</div>
<div class="line"><a name="l00343"></a><span class="lineno">  343</span>&#160;      {</div>
<div class="line"><a name="l00344"></a><span class="lineno">  344</span>&#160;        $node-&gt;setUseOfflineAsVirtual($uri-&gt;getQueryVar(<span class="stringliteral">&quot;use_offline_as_virtual&quot;</span>) ? TRUE : FALSE);</div>
<div class="line"><a name="l00345"></a><span class="lineno">  345</span>&#160;      }</div>
<div class="line"><a name="l00346"></a><span class="lineno">  346</span>&#160;</div>
<div class="line"><a name="l00347"></a><span class="lineno">  347</span>&#160;      <span class="comment">/* flag to fetch clients before sub-channels */</span></div>
<div class="line"><a name="l00348"></a><span class="lineno">  348</span>&#160;      <span class="keywordflow">if</span>($uri-&gt;getFragment() == <span class="stringliteral">&quot;clients_before_channels&quot;</span>)</div>
<div class="line"><a name="l00349"></a><span class="lineno">  349</span>&#160;      {</div>
<div class="line"><a name="l00350"></a><span class="lineno">  350</span>&#160;        $node-&gt;setLoadClientlistFirst(TRUE);</div>
<div class="line"><a name="l00351"></a><span class="lineno">  351</span>&#160;      }</div>
<div class="line"><a name="l00352"></a><span class="lineno">  352</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;clients_before_channels&quot;</span>))</div>
<div class="line"><a name="l00353"></a><span class="lineno">  353</span>&#160;      {</div>
<div class="line"><a name="l00354"></a><span class="lineno">  354</span>&#160;        $node-&gt;setLoadClientlistFirst($uri-&gt;getQueryVar(<span class="stringliteral">&quot;clients_before_channels&quot;</span>) ? TRUE : FALSE);</div>
<div class="line"><a name="l00355"></a><span class="lineno">  355</span>&#160;      }</div>
<div class="line"><a name="l00356"></a><span class="lineno">  356</span>&#160;</div>
<div class="line"><a name="l00357"></a><span class="lineno">  357</span>&#160;      <span class="comment">/* flag to hide ServerQuery clients */</span></div>
<div class="line"><a name="l00358"></a><span class="lineno">  358</span>&#160;      <span class="keywordflow">if</span>($uri-&gt;getFragment() == <span class="stringliteral">&quot;no_query_clients&quot;</span>)</div>
<div class="line"><a name="l00359"></a><span class="lineno">  359</span>&#160;      {</div>
<div class="line"><a name="l00360"></a><span class="lineno">  360</span>&#160;        $node-&gt;setExcludeQueryClients(TRUE);</div>
<div class="line"><a name="l00361"></a><span class="lineno">  361</span>&#160;      }</div>
<div class="line"><a name="l00362"></a><span class="lineno">  362</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;no_query_clients&quot;</span>))</div>
<div class="line"><a name="l00363"></a><span class="lineno">  363</span>&#160;      {</div>
<div class="line"><a name="l00364"></a><span class="lineno">  364</span>&#160;        $node-&gt;setExcludeQueryClients($uri-&gt;getQueryVar(<span class="stringliteral">&quot;no_query_clients&quot;</span>) ? TRUE : FALSE);</div>
<div class="line"><a name="l00365"></a><span class="lineno">  365</span>&#160;      }</div>
<div class="line"><a name="l00366"></a><span class="lineno">  366</span>&#160;</div>
<div class="line"><a name="l00367"></a><span class="lineno">  367</span>&#160;      <span class="comment">/* access server node object */</span></div>
<div class="line"><a name="l00368"></a><span class="lineno">  368</span>&#160;      <span class="keywordflow">if</span>($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;server_id&quot;</span>))</div>
<div class="line"><a name="l00369"></a><span class="lineno">  369</span>&#160;      {</div>
<div class="line"><a name="l00370"></a><span class="lineno">  370</span>&#160;        $node = $node-&gt;serverGetById($uri-&gt;getQueryVar(<span class="stringliteral">&quot;server_id&quot;</span>));</div>
<div class="line"><a name="l00371"></a><span class="lineno">  371</span>&#160;      }</div>
<div class="line"><a name="l00372"></a><span class="lineno">  372</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;server_uid&quot;</span>))</div>
<div class="line"><a name="l00373"></a><span class="lineno">  373</span>&#160;      {</div>
<div class="line"><a name="l00374"></a><span class="lineno">  374</span>&#160;        $node = $node-&gt;serverGetByUid($uri-&gt;getQueryVar(<span class="stringliteral">&quot;server_uid&quot;</span>));</div>
<div class="line"><a name="l00375"></a><span class="lineno">  375</span>&#160;      }</div>
<div class="line"><a name="l00376"></a><span class="lineno">  376</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;server_port&quot;</span>))</div>
<div class="line"><a name="l00377"></a><span class="lineno">  377</span>&#160;      {</div>
<div class="line"><a name="l00378"></a><span class="lineno">  378</span>&#160;        $node = $node-&gt;serverGetByPort($uri-&gt;getQueryVar(<span class="stringliteral">&quot;server_port&quot;</span>));</div>
<div class="line"><a name="l00379"></a><span class="lineno">  379</span>&#160;      }</div>
<div class="line"><a name="l00380"></a><span class="lineno">  380</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;server_name&quot;</span>))</div>
<div class="line"><a name="l00381"></a><span class="lineno">  381</span>&#160;      {</div>
<div class="line"><a name="l00382"></a><span class="lineno">  382</span>&#160;        $node = $node-&gt;serverGetByName($uri-&gt;getQueryVar(<span class="stringliteral">&quot;server_name&quot;</span>));</div>
<div class="line"><a name="l00383"></a><span class="lineno">  383</span>&#160;      }</div>
<div class="line"><a name="l00384"></a><span class="lineno">  384</span>&#160;      elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;server_tsdns&quot;</span>))</div>
<div class="line"><a name="l00385"></a><span class="lineno">  385</span>&#160;      {</div>
<div class="line"><a name="l00386"></a><span class="lineno">  386</span>&#160;        $node = $node-&gt;serverGetByTSDNS($uri-&gt;getQueryVar(<span class="stringliteral">&quot;server_tsdns&quot;</span>));</div>
<div class="line"><a name="l00387"></a><span class="lineno">  387</span>&#160;      }</div>
<div class="line"><a name="l00388"></a><span class="lineno">  388</span>&#160;</div>
<div class="line"><a name="l00389"></a><span class="lineno">  389</span>&#160;      <span class="comment">/* direct access to node objects */</span></div>
<div class="line"><a name="l00390"></a><span class="lineno">  390</span>&#160;      <span class="keywordflow">if</span>($node instanceof <a class="code" href="class_team_speak3___node___server.html" title="Class describing a TeamSpeak 3 virtual server and all it&#39;s parameters. ">TeamSpeak3_Node_Server</a>)</div>
<div class="line"><a name="l00391"></a><span class="lineno">  391</span>&#160;      {</div>
<div class="line"><a name="l00392"></a><span class="lineno">  392</span>&#160;        <span class="comment">/* access channel node object */</span></div>
<div class="line"><a name="l00393"></a><span class="lineno">  393</span>&#160;        <span class="keywordflow">if</span>($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;channel_id&quot;</span>))</div>
<div class="line"><a name="l00394"></a><span class="lineno">  394</span>&#160;        {</div>
<div class="line"><a name="l00395"></a><span class="lineno">  395</span>&#160;          $node = $node-&gt;channelGetById($uri-&gt;getQueryVar(<span class="stringliteral">&quot;channel_id&quot;</span>));</div>
<div class="line"><a name="l00396"></a><span class="lineno">  396</span>&#160;        }</div>
<div class="line"><a name="l00397"></a><span class="lineno">  397</span>&#160;        elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;channel_name&quot;</span>))</div>
<div class="line"><a name="l00398"></a><span class="lineno">  398</span>&#160;        {</div>
<div class="line"><a name="l00399"></a><span class="lineno">  399</span>&#160;          $node = $node-&gt;channelGetByName($uri-&gt;getQueryVar(<span class="stringliteral">&quot;channel_name&quot;</span>));</div>
<div class="line"><a name="l00400"></a><span class="lineno">  400</span>&#160;        }</div>
<div class="line"><a name="l00401"></a><span class="lineno">  401</span>&#160;</div>
<div class="line"><a name="l00402"></a><span class="lineno">  402</span>&#160;        <span class="comment">/* access client node object */</span></div>
<div class="line"><a name="l00403"></a><span class="lineno">  403</span>&#160;        <span class="keywordflow">if</span>($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;client_id&quot;</span>))</div>
<div class="line"><a name="l00404"></a><span class="lineno">  404</span>&#160;        {</div>
<div class="line"><a name="l00405"></a><span class="lineno">  405</span>&#160;          $node = $node-&gt;clientGetById($uri-&gt;getQueryVar(<span class="stringliteral">&quot;client_id&quot;</span>));</div>
<div class="line"><a name="l00406"></a><span class="lineno">  406</span>&#160;        }</div>
<div class="line"><a name="l00407"></a><span class="lineno">  407</span>&#160;        <span class="keywordflow">if</span>($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;client_uid&quot;</span>))</div>
<div class="line"><a name="l00408"></a><span class="lineno">  408</span>&#160;        {</div>
<div class="line"><a name="l00409"></a><span class="lineno">  409</span>&#160;          $node = $node-&gt;clientGetByUid($uri-&gt;getQueryVar(<span class="stringliteral">&quot;client_uid&quot;</span>));</div>
<div class="line"><a name="l00410"></a><span class="lineno">  410</span>&#160;        }</div>
<div class="line"><a name="l00411"></a><span class="lineno">  411</span>&#160;        elseif($uri-&gt;hasQueryVar(<span class="stringliteral">&quot;client_name&quot;</span>))</div>
<div class="line"><a name="l00412"></a><span class="lineno">  412</span>&#160;        {</div>
<div class="line"><a name="l00413"></a><span class="lineno">  413</span>&#160;          $node = $node-&gt;clientGetByName($uri-&gt;getQueryVar(<span class="stringliteral">&quot;client_name&quot;</span>));</div>
<div class="line"><a name="l00414"></a><span class="lineno">  414</span>&#160;        }</div>
<div class="line"><a name="l00415"></a><span class="lineno">  415</span>&#160;      }</div>
<div class="line"><a name="l00416"></a><span class="lineno">  416</span>&#160;</div>
<div class="line"><a name="l00417"></a><span class="lineno">  417</span>&#160;      <span class="keywordflow">return</span> $node;</div>
<div class="line"><a name="l00418"></a><span class="lineno">  418</span>&#160;    }</div>
<div class="line"><a name="l00419"></a><span class="lineno">  419</span>&#160;</div>
<div class="line"><a name="l00420"></a><span class="lineno">  420</span>&#160;    <span class="keywordflow">return</span> $object;</div>
<div class="line"><a name="l00421"></a><span class="lineno">  421</span>&#160;  }</div>
<div class="line"><a name="l00422"></a><span class="lineno">  422</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00423"></a><span class="lineno">  423</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00424"></a><span class="lineno">  424</span>&#160;<span class="comment">   * Loads a class from a PHP file. The filename must be formatted as &quot;$class.php&quot;.</span></div>
<div class="line"><a name="l00425"></a><span class="lineno">  425</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00426"></a><span class="lineno">  426</span>&#160;<span class="comment">   * include() is not prefixed with the @ operator because if the file is loaded and</span></div>
<div class="line"><a name="l00427"></a><span class="lineno">  427</span>&#160;<span class="comment">   * contains a parse error, execution will halt silently and this is difficult to debug.</span></div>
<div class="line"><a name="l00428"></a><span class="lineno">  428</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00429"></a><span class="lineno">  429</span>&#160;<span class="comment">   * @param  string $class</span></div>
<div class="line"><a name="l00430"></a><span class="lineno">  430</span>&#160;<span class="comment">   * @throws LogicException</span></div>
<div class="line"><a name="l00431"></a><span class="lineno">  431</span>&#160;<span class="comment">   * @return boolean</span></div>
<div class="line"><a name="l00432"></a><span class="lineno">  432</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00433"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a743962796b7626d9dbea7195036eecd3">  433</a></span>&#160;  <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#a743962796b7626d9dbea7195036eecd3" title="Loads a class from a PHP file. ">loadClass</a>($class)</div>
<div class="line"><a name="l00434"></a><span class="lineno">  434</span>&#160;  {</div>
<div class="line"><a name="l00435"></a><span class="lineno">  435</span>&#160;    <span class="keywordflow">if</span>(class_exists($class, FALSE) || interface_exists($class, FALSE))</div>
<div class="line"><a name="l00436"></a><span class="lineno">  436</span>&#160;    {</div>
<div class="line"><a name="l00437"></a><span class="lineno">  437</span>&#160;      <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00438"></a><span class="lineno">  438</span>&#160;    }</div>
<div class="line"><a name="l00439"></a><span class="lineno">  439</span>&#160;</div>
<div class="line"><a name="l00440"></a><span class="lineno">  440</span>&#160;    <span class="keywordflow">if</span>(preg_match(<span class="stringliteral">&quot;/[^a-z0-9\\/\\\\_.-]/i&quot;</span>, $class))</div>
<div class="line"><a name="l00441"></a><span class="lineno">  441</span>&#160;    {</div>
<div class="line"><a name="l00442"></a><span class="lineno">  442</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> LogicException(<span class="stringliteral">&quot;illegal characters in classname &#39;&quot;</span> . $class . <span class="stringliteral">&quot;&#39;&quot;</span>);</div>
<div class="line"><a name="l00443"></a><span class="lineno">  443</span>&#160;    }</div>
<div class="line"><a name="l00444"></a><span class="lineno">  444</span>&#160;</div>
<div class="line"><a name="l00445"></a><span class="lineno">  445</span>&#160;    $file = self::getFilePath($class) . <span class="stringliteral">&quot;.php&quot;</span>;</div>
<div class="line"><a name="l00446"></a><span class="lineno">  446</span>&#160;</div>
<div class="line"><a name="l00447"></a><span class="lineno">  447</span>&#160;    <span class="keywordflow">if</span>(!file_exists($file) || !is_readable($file))</div>
<div class="line"><a name="l00448"></a><span class="lineno">  448</span>&#160;    {</div>
<div class="line"><a name="l00449"></a><span class="lineno">  449</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> LogicException(<span class="stringliteral">&quot;file &#39;&quot;</span> . $file . <span class="stringliteral">&quot;&#39; does not exist or is not readable&quot;</span>);</div>
<div class="line"><a name="l00450"></a><span class="lineno">  450</span>&#160;    }</div>
<div class="line"><a name="l00451"></a><span class="lineno">  451</span>&#160;</div>
<div class="line"><a name="l00452"></a><span class="lineno">  452</span>&#160;    <span class="keywordflow">if</span>(class_exists($class, FALSE) || interface_exists($class, FALSE))</div>
<div class="line"><a name="l00453"></a><span class="lineno">  453</span>&#160;    {</div>
<div class="line"><a name="l00454"></a><span class="lineno">  454</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> LogicException(<span class="stringliteral">&quot;class &#39;&quot;</span> . $class . <span class="stringliteral">&quot;&#39; does not exist&quot;</span>);</div>
<div class="line"><a name="l00455"></a><span class="lineno">  455</span>&#160;    }</div>
<div class="line"><a name="l00456"></a><span class="lineno">  456</span>&#160;</div>
<div class="line"><a name="l00457"></a><span class="lineno">  457</span>&#160;    <span class="keywordflow">return</span> include_once($file);</div>
<div class="line"><a name="l00458"></a><span class="lineno">  458</span>&#160;  }</div>
<div class="line"><a name="l00459"></a><span class="lineno">  459</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00460"></a><span class="lineno">  460</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00461"></a><span class="lineno">  461</span>&#160;<span class="comment">   * Generates a possible file path for $name.</span></div>
<div class="line"><a name="l00462"></a><span class="lineno">  462</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00463"></a><span class="lineno">  463</span>&#160;<span class="comment">   * @param  string $name</span></div>
<div class="line"><a name="l00464"></a><span class="lineno">  464</span>&#160;<span class="comment">   * @return string</span></div>
<div class="line"><a name="l00465"></a><span class="lineno">  465</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00466"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a33bc8003224e5d95c46b00ccb1019cd7">  466</a></span>&#160;  <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#a33bc8003224e5d95c46b00ccb1019cd7" title="Generates a possible file path for $name. ">getFilePath</a>($name)</div>
<div class="line"><a name="l00467"></a><span class="lineno">  467</span>&#160;  {</div>
<div class="line"><a name="l00468"></a><span class="lineno">  468</span>&#160;    $path = str_replace(<span class="stringliteral">&quot;_&quot;</span>, DIRECTORY_SEPARATOR, $name);</div>
<div class="line"><a name="l00469"></a><span class="lineno">  469</span>&#160;    $path = str_replace(__CLASS__, dirname(__FILE__), $path);</div>
<div class="line"><a name="l00470"></a><span class="lineno">  470</span>&#160;</div>
<div class="line"><a name="l00471"></a><span class="lineno">  471</span>&#160;    <span class="keywordflow">return</span> $path;</div>
<div class="line"><a name="l00472"></a><span class="lineno">  472</span>&#160;  }</div>
<div class="line"><a name="l00473"></a><span class="lineno">  473</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00474"></a><span class="lineno">  474</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00475"></a><span class="lineno">  475</span>&#160;<span class="comment">   * Returns the name of an adapter class by $name.</span></div>
<div class="line"><a name="l00476"></a><span class="lineno">  476</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00477"></a><span class="lineno">  477</span>&#160;<span class="comment">   * @param  string $name</span></div>
<div class="line"><a name="l00478"></a><span class="lineno">  478</span>&#160;<span class="comment">   * @param  string $namespace</span></div>
<div class="line"><a name="l00479"></a><span class="lineno">  479</span>&#160;<span class="comment">   * @throws TeamSpeak3_Adapter_Exception</span></div>
<div class="line"><a name="l00480"></a><span class="lineno">  480</span>&#160;<span class="comment">   * @return string</span></div>
<div class="line"><a name="l00481"></a><span class="lineno">  481</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00482"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a222891a8da55aa7c6e7e4cba35d4a8c1">  482</a></span>&#160;  <span class="keyword">protected</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#a222891a8da55aa7c6e7e4cba35d4a8c1" title="Returns the name of an adapter class by $name. ">getAdapterName</a>($name, $namespace = <span class="stringliteral">&quot;TeamSpeak3_Adapter_&quot;</span>)</div>
<div class="line"><a name="l00483"></a><span class="lineno">  483</span>&#160;  {</div>
<div class="line"><a name="l00484"></a><span class="lineno">  484</span>&#160;    $path = self::getFilePath($namespace);</div>
<div class="line"><a name="l00485"></a><span class="lineno">  485</span>&#160;    $scan = scandir($path);</div>
<div class="line"><a name="l00486"></a><span class="lineno">  486</span>&#160;</div>
<div class="line"><a name="l00487"></a><span class="lineno">  487</span>&#160;    <span class="keywordflow">foreach</span>($scan as $node)</div>
<div class="line"><a name="l00488"></a><span class="lineno">  488</span>&#160;    {</div>
<div class="line"><a name="l00489"></a><span class="lineno">  489</span>&#160;      $file = <a class="code" href="class_team_speak3___helper___string.html#a475f5a602d67dd0568fb8c86352c88a0" title="Returns a TeamSpeak3_Helper_String object for thegiven string. ">TeamSpeak3_Helper_String::factory</a>($node)-&gt;toLower();</div>
<div class="line"><a name="l00490"></a><span class="lineno">  490</span>&#160;</div>
<div class="line"><a name="l00491"></a><span class="lineno">  491</span>&#160;      <span class="keywordflow">if</span>($file-&gt;startsWith($name) &amp;&amp; $file-&gt;endsWith(<span class="stringliteral">&quot;.php&quot;</span>))</div>
<div class="line"><a name="l00492"></a><span class="lineno">  492</span>&#160;      {</div>
<div class="line"><a name="l00493"></a><span class="lineno">  493</span>&#160;        <span class="keywordflow">return</span> $namespace . str_replace(<span class="stringliteral">&quot;.php&quot;</span>, <span class="stringliteral">&quot;&quot;</span>, $node);</div>
<div class="line"><a name="l00494"></a><span class="lineno">  494</span>&#160;      }</div>
<div class="line"><a name="l00495"></a><span class="lineno">  495</span>&#160;    }</div>
<div class="line"><a name="l00496"></a><span class="lineno">  496</span>&#160;</div>
<div class="line"><a name="l00497"></a><span class="lineno">  497</span>&#160;    <span class="keywordflow">throw</span> <span class="keyword">new</span> <a class="code" href="class_team_speak3___adapter___exception.html" title="Enhanced exception class for TeamSpeak3_Adapter_Abstract objects. ">TeamSpeak3_Adapter_Exception</a>(<span class="stringliteral">&quot;adapter &#39;&quot;</span> . $name . <span class="stringliteral">&quot;&#39; does not exist&quot;</span>);</div>
<div class="line"><a name="l00498"></a><span class="lineno">  498</span>&#160;  }</div>
<div class="line"><a name="l00499"></a><span class="lineno">  499</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00500"></a><span class="lineno">  500</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00501"></a><span class="lineno">  501</span>&#160;<span class="comment">   * spl_autoload() suitable implementation for supporting class autoloading.</span></div>
<div class="line"><a name="l00502"></a><span class="lineno">  502</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00503"></a><span class="lineno">  503</span>&#160;<span class="comment">   * @param  string $class</span></div>
<div class="line"><a name="l00504"></a><span class="lineno">  504</span>&#160;<span class="comment">   * @return boolean</span></div>
<div class="line"><a name="l00505"></a><span class="lineno">  505</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00506"></a><span class="lineno"><a class="code" href="class_team_speak3.html#aba738bb754c3d3ae892c65943ca6f082">  506</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#aba738bb754c3d3ae892c65943ca6f082" title="spl_autoload() suitable implementation for supporting class autoloading. ">autoload</a>($class)</div>
<div class="line"><a name="l00507"></a><span class="lineno">  507</span>&#160;  {</div>
<div class="line"><a name="l00508"></a><span class="lineno">  508</span>&#160;    <span class="keywordflow">if</span>(substr($class, 0, strlen(__CLASS__)) != __CLASS__) <span class="keywordflow">return</span>;</div>
<div class="line"><a name="l00509"></a><span class="lineno">  509</span>&#160;</div>
<div class="line"><a name="l00510"></a><span class="lineno">  510</span>&#160;    <span class="keywordflow">try</span></div>
<div class="line"><a name="l00511"></a><span class="lineno">  511</span>&#160;    {</div>
<div class="line"><a name="l00512"></a><span class="lineno">  512</span>&#160;      self::loadClass($class);</div>
<div class="line"><a name="l00513"></a><span class="lineno">  513</span>&#160;</div>
<div class="line"><a name="l00514"></a><span class="lineno">  514</span>&#160;      <span class="keywordflow">return</span> TRUE;</div>
<div class="line"><a name="l00515"></a><span class="lineno">  515</span>&#160;    }</div>
<div class="line"><a name="l00516"></a><span class="lineno">  516</span>&#160;    <span class="keywordflow">catch</span>(Exception $e)</div>
<div class="line"><a name="l00517"></a><span class="lineno">  517</span>&#160;    {</div>
<div class="line"><a name="l00518"></a><span class="lineno">  518</span>&#160;      <span class="keywordflow">return</span> FALSE;</div>
<div class="line"><a name="l00519"></a><span class="lineno">  519</span>&#160;    }</div>
<div class="line"><a name="l00520"></a><span class="lineno">  520</span>&#160;  }</div>
<div class="line"><a name="l00521"></a><span class="lineno">  521</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00522"></a><span class="lineno">  522</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00523"></a><span class="lineno">  523</span>&#160;<span class="comment">   * Checks for required PHP features, enables autoloading and starts a default profiler.</span></div>
<div class="line"><a name="l00524"></a><span class="lineno">  524</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00525"></a><span class="lineno">  525</span>&#160;<span class="comment">   * @throws LogicException</span></div>
<div class="line"><a name="l00526"></a><span class="lineno">  526</span>&#160;<span class="comment">   * @return void</span></div>
<div class="line"><a name="l00527"></a><span class="lineno">  527</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00528"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a87bd78e5017a04145076860846395a7d">  528</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#a87bd78e5017a04145076860846395a7d" title="Checks for required PHP features, enables autoloading and starts a default profiler. ">init</a>()</div>
<div class="line"><a name="l00529"></a><span class="lineno">  529</span>&#160;  {</div>
<div class="line"><a name="l00530"></a><span class="lineno">  530</span>&#160;    <span class="keywordflow">if</span>(version_compare(phpversion(), <span class="stringliteral">&quot;5.2.1&quot;</span>) == -1)</div>
<div class="line"><a name="l00531"></a><span class="lineno">  531</span>&#160;    {</div>
<div class="line"><a name="l00532"></a><span class="lineno">  532</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> LogicException(<span class="stringliteral">&quot;this particular software cannot be used with the installed version of PHP&quot;</span>);</div>
<div class="line"><a name="l00533"></a><span class="lineno">  533</span>&#160;    }</div>
<div class="line"><a name="l00534"></a><span class="lineno">  534</span>&#160;</div>
<div class="line"><a name="l00535"></a><span class="lineno">  535</span>&#160;    <span class="keywordflow">if</span>(!function_exists(<span class="stringliteral">&quot;stream_socket_client&quot;</span>))</div>
<div class="line"><a name="l00536"></a><span class="lineno">  536</span>&#160;    {</div>
<div class="line"><a name="l00537"></a><span class="lineno">  537</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> LogicException(<span class="stringliteral">&quot;network functions are not available in this PHP installation&quot;</span>);</div>
<div class="line"><a name="l00538"></a><span class="lineno">  538</span>&#160;    }</div>
<div class="line"><a name="l00539"></a><span class="lineno">  539</span>&#160;</div>
<div class="line"><a name="l00540"></a><span class="lineno">  540</span>&#160;    <span class="keywordflow">if</span>(!function_exists(<span class="stringliteral">&quot;spl_autoload_register&quot;</span>))</div>
<div class="line"><a name="l00541"></a><span class="lineno">  541</span>&#160;    {</div>
<div class="line"><a name="l00542"></a><span class="lineno">  542</span>&#160;      <span class="keywordflow">throw</span> <span class="keyword">new</span> LogicException(<span class="stringliteral">&quot;autoload functions are not available in this PHP installation&quot;</span>);</div>
<div class="line"><a name="l00543"></a><span class="lineno">  543</span>&#160;    }</div>
<div class="line"><a name="l00544"></a><span class="lineno">  544</span>&#160;</div>
<div class="line"><a name="l00545"></a><span class="lineno">  545</span>&#160;    <span class="keywordflow">if</span>(!class_exists(<span class="stringliteral">&quot;TeamSpeak3_Helper_Profiler&quot;</span>))</div>
<div class="line"><a name="l00546"></a><span class="lineno">  546</span>&#160;    {</div>
<div class="line"><a name="l00547"></a><span class="lineno">  547</span>&#160;      spl_autoload_register(array(__CLASS__, <span class="stringliteral">&quot;autoload&quot;</span>));</div>
<div class="line"><a name="l00548"></a><span class="lineno">  548</span>&#160;    }</div>
<div class="line"><a name="l00549"></a><span class="lineno">  549</span>&#160;</div>
<div class="line"><a name="l00550"></a><span class="lineno">  550</span>&#160;    <a class="code" href="class_team_speak3___helper___profiler.html#a58f37c77d468aab64bc832a476d02329" title="Starts a timer. ">TeamSpeak3_Helper_Profiler::start</a>();</div>
<div class="line"><a name="l00551"></a><span class="lineno">  551</span>&#160;  }</div>
<div class="line"><a name="l00552"></a><span class="lineno">  552</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00553"></a><span class="lineno">  553</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00554"></a><span class="lineno">  554</span>&#160;<span class="comment">   * Returns an assoc array containing all escape patterns available on a TeamSpeak 3</span></div>
<div class="line"><a name="l00555"></a><span class="lineno">  555</span>&#160;<span class="comment">   * Server.</span></div>
<div class="line"><a name="l00556"></a><span class="lineno">  556</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00557"></a><span class="lineno">  557</span>&#160;<span class="comment">   * @return array</span></div>
<div class="line"><a name="l00558"></a><span class="lineno">  558</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00559"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a09e261dfec76e4be66f3fa031a33e12f">  559</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#a09e261dfec76e4be66f3fa031a33e12f" title="Returns an assoc array containing all escape patterns available on a TeamSpeak 3 Server. ">getEscapePatterns</a>()</div>
<div class="line"><a name="l00560"></a><span class="lineno">  560</span>&#160;  {</div>
<div class="line"><a name="l00561"></a><span class="lineno">  561</span>&#160;    <span class="keywordflow">return</span> self::$escape_patterns;</div>
<div class="line"><a name="l00562"></a><span class="lineno">  562</span>&#160;  }</div>
<div class="line"><a name="l00563"></a><span class="lineno">  563</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00564"></a><span class="lineno">  564</span>&#160;<span class="comment">  /**</span></div>
<div class="line"><a name="l00565"></a><span class="lineno">  565</span>&#160;<span class="comment">   * Debug helper function. This is a wrapper for var_dump() that adds the pre-format tags,</span></div>
<div class="line"><a name="l00566"></a><span class="lineno">  566</span>&#160;<span class="comment">   * cleans up newlines and indents, and runs htmlentities() before output.</span></div>
<div class="line"><a name="l00567"></a><span class="lineno">  567</span>&#160;<span class="comment">   *</span></div>
<div class="line"><a name="l00568"></a><span class="lineno">  568</span>&#160;<span class="comment">   * @param  mixed  $var</span></div>
<div class="line"><a name="l00569"></a><span class="lineno">  569</span>&#160;<span class="comment">   * @param  bool   $echo</span></div>
<div class="line"><a name="l00570"></a><span class="lineno">  570</span>&#160;<span class="comment">   * @return string</span></div>
<div class="line"><a name="l00571"></a><span class="lineno">  571</span>&#160;<span class="comment">   */</span></div>
<div class="line"><a name="l00572"></a><span class="lineno"><a class="code" href="class_team_speak3.html#a152db9cb030dfc497e0b276ee312654d">  572</a></span>&#160;  <span class="keyword">public</span> <span class="keyword">static</span> <span class="keyword">function</span> <a class="code" href="class_team_speak3.html#a152db9cb030dfc497e0b276ee312654d" title="Debug helper function. ">dump</a>($var, $echo = TRUE)</div>
<div class="line"><a name="l00573"></a><span class="lineno">  573</span>&#160;  {</div>
<div class="line"><a name="l00574"></a><span class="lineno">  574</span>&#160;    ob_start();</div>
<div class="line"><a name="l00575"></a><span class="lineno">  575</span>&#160;    var_dump($var);</div>
<div class="line"><a name="l00576"></a><span class="lineno">  576</span>&#160;</div>
<div class="line"><a name="l00577"></a><span class="lineno">  577</span>&#160;    $output = ob_get_clean();</div>
<div class="line"><a name="l00578"></a><span class="lineno">  578</span>&#160;    $output = preg_replace(<span class="stringliteral">&quot;/\]\=&gt;\n(\s+)/m&quot;</span>, <span class="stringliteral">&quot;] =&gt; &quot;</span>, $output);</div>
<div class="line"><a name="l00579"></a><span class="lineno">  579</span>&#160;</div>
<div class="line"><a name="l00580"></a><span class="lineno">  580</span>&#160;    <span class="keywordflow">if</span>(PHP_SAPI == <span class="stringliteral">&quot;cli&quot;</span>)</div>
<div class="line"><a name="l00581"></a><span class="lineno">  581</span>&#160;    {</div>
<div class="line"><a name="l00582"></a><span class="lineno">  582</span>&#160;      $output = PHP_EOL . PHP_EOL . $output . PHP_EOL;</div>
<div class="line"><a name="l00583"></a><span class="lineno">  583</span>&#160;    }</div>
<div class="line"><a name="l00584"></a><span class="lineno">  584</span>&#160;    <span class="keywordflow">else</span></div>
<div class="line"><a name="l00585"></a><span class="lineno">  585</span>&#160;    {</div>
<div class="line"><a name="l00586"></a><span class="lineno">  586</span>&#160;      $output = <span class="stringliteral">&quot;&lt;pre&gt;&quot;</span> . htmlspecialchars($output, ENT_QUOTES) . <span class="stringliteral">&quot;&lt;/pre&gt;&quot;</span>;</div>
<div class="line"><a name="l00587"></a><span class="lineno">  587</span>&#160;    }</div>
<div class="line"><a name="l00588"></a><span class="lineno">  588</span>&#160;</div>
<div class="line"><a name="l00589"></a><span class="lineno">  589</span>&#160;    <span class="keywordflow">if</span>($echo) echo($output);</div>
<div class="line"><a name="l00590"></a><span class="lineno">  590</span>&#160;</div>
<div class="line"><a name="l00591"></a><span class="lineno">  591</span>&#160;    <span class="keywordflow">return</span> $output;</div>
<div class="line"><a name="l00592"></a><span class="lineno">  592</span>&#160;  }</div>
<div class="line"><a name="l00593"></a><span class="lineno">  593</span>&#160;}</div>
<div class="line"><a name="l00594"></a><span class="lineno">  594</span>&#160;<span class="comment"></span></div>
<div class="line"><a name="l00595"></a><span class="lineno">  595</span>&#160;<span class="comment">/*!</span></div>
<div class="line"><a name="l00596"></a><span class="lineno">  596</span>&#160;<span class="comment"> * \mainpage API Documentation</span></div>
<div class="line"><a name="l00597"></a><span class="lineno">  597</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00598"></a><span class="lineno">  598</span>&#160;<span class="comment"> * \section welcome_sec Introduction</span></div>
<div class="line"><a name="l00599"></a><span class="lineno">  599</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00600"></a><span class="lineno">  600</span>&#160;<span class="comment"> * \subsection welcome1 What is the TS3 PHP Framework?</span></div>
<div class="line"><a name="l00601"></a><span class="lineno">  601</span>&#160;<span class="comment"> * Initially released in January 2010, the TS3 PHP Framework is a powerful, open source, object-oriented framework</span></div>
<div class="line"><a name="l00602"></a><span class="lineno">  602</span>&#160;<span class="comment"> * implemented in PHP 5 and licensed under the GNU General Public License. It&#39;s based on simplicity and a rigorously</span></div>
<div class="line"><a name="l00603"></a><span class="lineno">  603</span>&#160;<span class="comment"> * tested agile codebase. Extend the functionality of your servers with scripts or create powerful web applications</span></div>
<div class="line"><a name="l00604"></a><span class="lineno">  604</span>&#160;<span class="comment"> * to manage all features of your TeamSpeak 3 Server instances.</span></div>
<div class="line"><a name="l00605"></a><span class="lineno">  605</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00606"></a><span class="lineno">  606</span>&#160;<span class="comment"> * Tested. Thoroughly. Enterprise-ready and built with agile methods, the TS3 PHP Framework has been unit-tested from</span></div>
<div class="line"><a name="l00607"></a><span class="lineno">  607</span>&#160;<span class="comment"> * the start to ensure that all code remains stable and easy for you to extend, re-test with your extensions, and</span></div>
<div class="line"><a name="l00608"></a><span class="lineno">  608</span>&#160;<span class="comment"> * further maintain.</span></div>
<div class="line"><a name="l00609"></a><span class="lineno">  609</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00610"></a><span class="lineno">  610</span>&#160;<span class="comment"> * \subsection welcome2 Why should I use the TS3 PHP Framework rather than other PHP libraries?</span></div>
<div class="line"><a name="l00611"></a><span class="lineno">  611</span>&#160;<span class="comment"> * The TS3 PHP Framework is a is a modern use-at-will framework that provides individual components to communicate</span></div>
<div class="line"><a name="l00612"></a><span class="lineno">  612</span>&#160;<span class="comment"> * with the TeamSpeak 3 Server.</span></div>
<div class="line"><a name="l00613"></a><span class="lineno">  613</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00614"></a><span class="lineno">  614</span>&#160;<span class="comment"> * There are lots of arguments for the TS3 PHP Framework in comparison with other PHP based libraries. It is the most</span></div>
<div class="line"><a name="l00615"></a><span class="lineno">  615</span>&#160;<span class="comment"> * dynamic and feature-rich piece of software in its class. In addition, it&#39;s always up-to-date and 100% compatible to </span></div>
<div class="line"><a name="l00616"></a><span class="lineno">  616</span>&#160;<span class="comment"> * almost any TeamSpeak 3 Server version available.</span></div>
<div class="line"><a name="l00617"></a><span class="lineno">  617</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00618"></a><span class="lineno">  618</span>&#160;<span class="comment"> * \section sysreqs_sec Requirements</span></div>
<div class="line"><a name="l00619"></a><span class="lineno">  619</span>&#160;<span class="comment"> * The TS3 PHP Framework currently supports PHP 5.2.1 or later, but we strongly recommend the most current release of</span></div>
<div class="line"><a name="l00620"></a><span class="lineno">  620</span>&#160;<span class="comment"> * PHP for critical security and performance enhancements. If you want to create a web application using the TS3 PHP</span></div>
<div class="line"><a name="l00621"></a><span class="lineno">  621</span>&#160;<span class="comment"> * Framework, you need a PHP 5 interpreter with a web server configured to handle PHP scripts correctly.</span></div>
<div class="line"><a name="l00622"></a><span class="lineno">  622</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00623"></a><span class="lineno">  623</span>&#160;<span class="comment"> * Note that the majority of TS3 PHP Framework development and deployment is done on nginx, so there is more community</span></div>
<div class="line"><a name="l00624"></a><span class="lineno">  624</span>&#160;<span class="comment"> * experience and testing performed on nginx than on other web servers.</span></div>
<div class="line"><a name="l00625"></a><span class="lineno">  625</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00626"></a><span class="lineno">  626</span>&#160;<span class="comment"> * \section feature_sec Features</span></div>
<div class="line"><a name="l00627"></a><span class="lineno">  627</span>&#160;<span class="comment"> * Features of the TS3 PHP Framework include:</span></div>
<div class="line"><a name="l00628"></a><span class="lineno">  628</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00629"></a><span class="lineno">  629</span>&#160;<span class="comment"> *   - Fully object-oriented PHP 5 and E_STRICT compliant components</span></div>
<div class="line"><a name="l00630"></a><span class="lineno">  630</span>&#160;<span class="comment"> *   - Access to all TeamSpeak 3 Server features via ServerQuery</span></div>
<div class="line"><a name="l00631"></a><span class="lineno">  631</span>&#160;<span class="comment"> *   - Integrated full featured and customizable TSViewer interfaces</span></div>
<div class="line"><a name="l00632"></a><span class="lineno">  632</span>&#160;<span class="comment"> *   - Full support for file transfers to up- and /or download custom icons and other stuff</span></div>
<div class="line"><a name="l00633"></a><span class="lineno">  633</span>&#160;<span class="comment"> *   - Powerful error handling capablities using exceptions and customizable error messages</span></div>
<div class="line"><a name="l00634"></a><span class="lineno">  634</span>&#160;<span class="comment"> *   - Query mechanisms for several official services such as the blacklist and auto-update servers</span></div>
<div class="line"><a name="l00635"></a><span class="lineno">  635</span>&#160;<span class="comment"> *   - Dynamic signal slots for event based scripting</span></div>
<div class="line"><a name="l00636"></a><span class="lineno">  636</span>&#160;<span class="comment"> *   - ...</span></div>
<div class="line"><a name="l00637"></a><span class="lineno">  637</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00638"></a><span class="lineno">  638</span>&#160;<span class="comment"> * \section example_sec Usage Examples</span></div>
<div class="line"><a name="l00639"></a><span class="lineno">  639</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00640"></a><span class="lineno">  640</span>&#160;<span class="comment"> * \subsection example1 1. Kick a single Client from a Virtual Server</span></div>
<div class="line"><a name="l00641"></a><span class="lineno">  641</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00642"></a><span class="lineno">  642</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00643"></a><span class="lineno">  643</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00644"></a><span class="lineno">  644</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00645"></a><span class="lineno">  645</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00646"></a><span class="lineno">  646</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00647"></a><span class="lineno">  647</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00648"></a><span class="lineno">  648</span>&#160;<span class="comment"> *   // kick the client with ID 123 from the server</span></div>
<div class="line"><a name="l00649"></a><span class="lineno">  649</span>&#160;<span class="comment"> *   $ts3_VirtualServer-&gt;clientKick(123, TeamSpeak3::KICK_SERVER, &quot;evil kick XD&quot;);</span></div>
<div class="line"><a name="l00650"></a><span class="lineno">  650</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00651"></a><span class="lineno">  651</span>&#160;<span class="comment"> *   // spawn an object for the client by unique identifier and do the kick</span></div>
<div class="line"><a name="l00652"></a><span class="lineno">  652</span>&#160;<span class="comment"> *   $ts3_VirtualServer-&gt;clientGetByUid(&quot;FPMPSC6MXqXq751dX7BKV0JniSo=&quot;)-&gt;kick(TeamSpeak3::KICK_SERVER, &quot;evil kick XD&quot;);</span></div>
<div class="line"><a name="l00653"></a><span class="lineno">  653</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00654"></a><span class="lineno">  654</span>&#160;<span class="comment"> *   // spawn an object for the client by current nickname and do the kick</span></div>
<div class="line"><a name="l00655"></a><span class="lineno">  655</span>&#160;<span class="comment"> *   $ts3_VirtualServer-&gt;clientGetByName(&quot;ScP&quot;)-&gt;kick(TeamSpeak3::KICK_SERVER, &quot;evil kick XD&quot;);</span></div>
<div class="line"><a name="l00656"></a><span class="lineno">  656</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00657"></a><span class="lineno">  657</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00658"></a><span class="lineno">  658</span>&#160;<span class="comment"> * \subsection example2 2. Kick all Clients from a Virtual Server</span></div>
<div class="line"><a name="l00659"></a><span class="lineno">  659</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00660"></a><span class="lineno">  660</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00661"></a><span class="lineno">  661</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00662"></a><span class="lineno">  662</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00663"></a><span class="lineno">  663</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00664"></a><span class="lineno">  664</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00665"></a><span class="lineno">  665</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00666"></a><span class="lineno">  666</span>&#160;<span class="comment"> *   // query clientlist from virtual server</span></div>
<div class="line"><a name="l00667"></a><span class="lineno">  667</span>&#160;<span class="comment"> *   $arr_ClientList = $ts3_VirtualServer-&gt;clientList();</span></div>
<div class="line"><a name="l00668"></a><span class="lineno">  668</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00669"></a><span class="lineno">  669</span>&#160;<span class="comment"> *   // kick all clients online with a single command</span></div>
<div class="line"><a name="l00670"></a><span class="lineno">  670</span>&#160;<span class="comment"> *   $ts3_VirtualServer-&gt;clientKick($arr_ClientList, TeamSpeak3::KICK_SERVER, &quot;evil kick XD&quot;);</span></div>
<div class="line"><a name="l00671"></a><span class="lineno">  671</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00672"></a><span class="lineno">  672</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00673"></a><span class="lineno">  673</span>&#160;<span class="comment"> * \subsection example3 3. Print the Nicknames of connected Android Clients</span></div>
<div class="line"><a name="l00674"></a><span class="lineno">  674</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00675"></a><span class="lineno">  675</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00676"></a><span class="lineno">  676</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00677"></a><span class="lineno">  677</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00678"></a><span class="lineno">  678</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00679"></a><span class="lineno">  679</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00680"></a><span class="lineno">  680</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00681"></a><span class="lineno">  681</span>&#160;<span class="comment"> *   // query clientlist from virtual server and filter by platform</span></div>
<div class="line"><a name="l00682"></a><span class="lineno">  682</span>&#160;<span class="comment"> *   $arr_ClientList = $ts3_VirtualServer-&gt;clientList(array(&quot;client_platform&quot; =&gt; &quot;Android&quot;));</span></div>
<div class="line"><a name="l00683"></a><span class="lineno">  683</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00684"></a><span class="lineno">  684</span>&#160;<span class="comment"> *   // walk through list of clients</span></div>
<div class="line"><a name="l00685"></a><span class="lineno">  685</span>&#160;<span class="comment"> *   foreach($arr_ClientList as $ts3_Client)</span></div>
<div class="line"><a name="l00686"></a><span class="lineno">  686</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00687"></a><span class="lineno">  687</span>&#160;<span class="comment"> *     echo $ts3_Client . &quot; is using &quot; . $ts3_Client[&quot;client_platform&quot;] . &quot;&lt;br /&gt;\n&quot;;</span></div>
<div class="line"><a name="l00688"></a><span class="lineno">  688</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00689"></a><span class="lineno">  689</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00690"></a><span class="lineno">  690</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00691"></a><span class="lineno">  691</span>&#160;<span class="comment"> * \subsection example4 4. Modify the Settings of each Virtual Server</span></div>
<div class="line"><a name="l00692"></a><span class="lineno">  692</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00693"></a><span class="lineno">  693</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00694"></a><span class="lineno">  694</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00695"></a><span class="lineno">  695</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00696"></a><span class="lineno">  696</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the server instance</span></div>
<div class="line"><a name="l00697"></a><span class="lineno">  697</span>&#160;<span class="comment"> *   $ts3_ServerInstance = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/&quot;);</span></div>
<div class="line"><a name="l00698"></a><span class="lineno">  698</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00699"></a><span class="lineno">  699</span>&#160;<span class="comment"> *   // walk through list of virtual servers</span></div>
<div class="line"><a name="l00700"></a><span class="lineno">  700</span>&#160;<span class="comment"> *   foreach($ts3_ServerInstance as $ts3_VirtualServer)</span></div>
<div class="line"><a name="l00701"></a><span class="lineno">  701</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00702"></a><span class="lineno">  702</span>&#160;<span class="comment"> *     // modify the virtual servers hostbanner URL only using the ArrayAccess interface</span></div>
<div class="line"><a name="l00703"></a><span class="lineno">  703</span>&#160;<span class="comment"> *     $ts3_VirtualServer[&quot;virtualserver_hostbanner_gfx_url&quot;] = &quot;http://www.example.com/banners/banner01_468x60.jpg&quot;;</span></div>
<div class="line"><a name="l00704"></a><span class="lineno">  704</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00705"></a><span class="lineno">  705</span>&#160;<span class="comment"> *     // modify the virtual servers hostbanner URL only using property overloading</span></div>
<div class="line"><a name="l00706"></a><span class="lineno">  706</span>&#160;<span class="comment"> *     $ts3_VirtualServer-&gt;virtualserver_hostbanner_gfx_url = &quot;http://www.example.com/banners/banner01_468x60.jpg&quot;;</span></div>
<div class="line"><a name="l00707"></a><span class="lineno">  707</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00708"></a><span class="lineno">  708</span>&#160;<span class="comment"> *     // modify multiple virtual server properties at once</span></div>
<div class="line"><a name="l00709"></a><span class="lineno">  709</span>&#160;<span class="comment"> *     $ts3_VirtualServer-&gt;modify(array(</span></div>
<div class="line"><a name="l00710"></a><span class="lineno">  710</span>&#160;<span class="comment"> *       &quot;virtualserver_hostbutton_tooltip&quot; =&gt; &quot;My Company&quot;,</span></div>
<div class="line"><a name="l00711"></a><span class="lineno">  711</span>&#160;<span class="comment"> *       &quot;virtualserver_hostbutton_url&quot;     =&gt; &quot;http://www.example.com&quot;,</span></div>
<div class="line"><a name="l00712"></a><span class="lineno">  712</span>&#160;<span class="comment"> *       &quot;virtualserver_hostbutton_gfx_url&quot; =&gt; &quot;http://www.example.com/buttons/button01_24x24.jpg&quot;,</span></div>
<div class="line"><a name="l00713"></a><span class="lineno">  713</span>&#160;<span class="comment"> *     ));</span></div>
<div class="line"><a name="l00714"></a><span class="lineno">  714</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00715"></a><span class="lineno">  715</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00716"></a><span class="lineno">  716</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00717"></a><span class="lineno">  717</span>&#160;<span class="comment"> * \subsection example5 5. Create a Privilege Key for a Server Group</span></div>
<div class="line"><a name="l00718"></a><span class="lineno">  718</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00719"></a><span class="lineno">  719</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00720"></a><span class="lineno">  720</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00721"></a><span class="lineno">  721</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00722"></a><span class="lineno">  722</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00723"></a><span class="lineno">  723</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00724"></a><span class="lineno">  724</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00725"></a><span class="lineno">  725</span>&#160;<span class="comment"> *   // spawn an object for the group using a specified name</span></div>
<div class="line"><a name="l00726"></a><span class="lineno">  726</span>&#160;<span class="comment"> *   $arr_ServerGroup = $ts3_VirtualServer-&gt;serverGroupGetByName(&quot;Admins&quot;);</span></div>
<div class="line"><a name="l00727"></a><span class="lineno">  727</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00728"></a><span class="lineno">  728</span>&#160;<span class="comment"> *   // create the privilege key</span></div>
<div class="line"><a name="l00729"></a><span class="lineno">  729</span>&#160;<span class="comment"> *   $ts3_PrivilegeKey = $arr_ServerGroup-&gt;privilegeKeyCreate();</span></div>
<div class="line"><a name="l00730"></a><span class="lineno">  730</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00731"></a><span class="lineno">  731</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00732"></a><span class="lineno">  732</span>&#160;<span class="comment"> * \subsection example6 6. Modify the Permissions of Admins on each Virtual Server</span></div>
<div class="line"><a name="l00733"></a><span class="lineno">  733</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00734"></a><span class="lineno">  734</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00735"></a><span class="lineno">  735</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00736"></a><span class="lineno">  736</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00737"></a><span class="lineno">  737</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the server instance</span></div>
<div class="line"><a name="l00738"></a><span class="lineno">  738</span>&#160;<span class="comment"> *   $ts3_ServerInstance = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/&quot;);</span></div>
<div class="line"><a name="l00739"></a><span class="lineno">  739</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00740"></a><span class="lineno">  740</span>&#160;<span class="comment"> *   // walk through list of virtual servers</span></div>
<div class="line"><a name="l00741"></a><span class="lineno">  741</span>&#160;<span class="comment"> *   foreach($ts3_ServerInstance as $ts3_VirtualServer)</span></div>
<div class="line"><a name="l00742"></a><span class="lineno">  742</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00743"></a><span class="lineno">  743</span>&#160;<span class="comment"> *     // identify the most powerful group on the virtual server</span></div>
<div class="line"><a name="l00744"></a><span class="lineno">  744</span>&#160;<span class="comment"> *     $ts3_ServerGroup = $ts3_VirtualServer-&gt;serverGroupIdentify();</span></div>
<div class="line"><a name="l00745"></a><span class="lineno">  745</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00746"></a><span class="lineno">  746</span>&#160;<span class="comment"> *     // assign a new permission</span></div>
<div class="line"><a name="l00747"></a><span class="lineno">  747</span>&#160;<span class="comment"> *     $ts3_ServerGroup-&gt;permAssign(&quot;b_virtualserver_modify_hostbanner&quot;, TRUE);</span></div>
<div class="line"><a name="l00748"></a><span class="lineno">  748</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00749"></a><span class="lineno">  749</span>&#160;<span class="comment"> *     // revoke an existing permission</span></div>
<div class="line"><a name="l00750"></a><span class="lineno">  750</span>&#160;<span class="comment"> *     $ts3_ServerGroup-&gt;permRemove(&quot;b_virtualserver_modify_maxclients&quot;);</span></div>
<div class="line"><a name="l00751"></a><span class="lineno">  751</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00752"></a><span class="lineno">  752</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00753"></a><span class="lineno">  753</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00754"></a><span class="lineno">  754</span>&#160;<span class="comment"> * \subsection example7 7. Create a new Virtual Server</span></div>
<div class="line"><a name="l00755"></a><span class="lineno">  755</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00756"></a><span class="lineno">  756</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00757"></a><span class="lineno">  757</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00758"></a><span class="lineno">  758</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00759"></a><span class="lineno">  759</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the server instance</span></div>
<div class="line"><a name="l00760"></a><span class="lineno">  760</span>&#160;<span class="comment"> *   $ts3_ServerInstance = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/&quot;);</span></div>
<div class="line"><a name="l00761"></a><span class="lineno">  761</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00762"></a><span class="lineno">  762</span>&#160;<span class="comment"> *   // create a virtual server and get its ID</span></div>
<div class="line"><a name="l00763"></a><span class="lineno">  763</span>&#160;<span class="comment"> *   $new_sid = $ts3_ServerInstance-&gt;serverCreate(array(</span></div>
<div class="line"><a name="l00764"></a><span class="lineno">  764</span>&#160;<span class="comment"> *     &quot;virtualserver_name&quot;               =&gt; &quot;My TeamSpeak 3 Server&quot;,</span></div>
<div class="line"><a name="l00765"></a><span class="lineno">  765</span>&#160;<span class="comment"> *     &quot;virtualserver_maxclients&quot;         =&gt; 64,</span></div>
<div class="line"><a name="l00766"></a><span class="lineno">  766</span>&#160;<span class="comment"> *     &quot;virtualserver_hostbutton_tooltip&quot; =&gt; &quot;My Company&quot;,</span></div>
<div class="line"><a name="l00767"></a><span class="lineno">  767</span>&#160;<span class="comment"> *     &quot;virtualserver_hostbutton_url&quot;     =&gt; &quot;http://www.example.com&quot;,</span></div>
<div class="line"><a name="l00768"></a><span class="lineno">  768</span>&#160;<span class="comment"> *     &quot;virtualserver_hostbutton_gfx_url&quot; =&gt; &quot;http://www.example.com/buttons/button01_24x24.jpg&quot;,</span></div>
<div class="line"><a name="l00769"></a><span class="lineno">  769</span>&#160;<span class="comment"> *   ));</span></div>
<div class="line"><a name="l00770"></a><span class="lineno">  770</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00771"></a><span class="lineno">  771</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00772"></a><span class="lineno">  772</span>&#160;<span class="comment"> * \subsection example8 8. Create a hierarchical Channel Stucture</span></div>
<div class="line"><a name="l00773"></a><span class="lineno">  773</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00774"></a><span class="lineno">  774</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00775"></a><span class="lineno">  775</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00776"></a><span class="lineno">  776</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00777"></a><span class="lineno">  777</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00778"></a><span class="lineno">  778</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00779"></a><span class="lineno">  779</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00780"></a><span class="lineno">  780</span>&#160;<span class="comment"> *   // create a top-level channel and get its ID</span></div>
<div class="line"><a name="l00781"></a><span class="lineno">  781</span>&#160;<span class="comment"> *   $top_cid = $ts3_VirtualServer-&gt;channelCreate(array(</span></div>
<div class="line"><a name="l00782"></a><span class="lineno">  782</span>&#160;<span class="comment"> *     &quot;channel_name&quot;           =&gt; &quot;My Channel&quot;,</span></div>
<div class="line"><a name="l00783"></a><span class="lineno">  783</span>&#160;<span class="comment"> *     &quot;channel_topic&quot;          =&gt; &quot;This is a top-level channel&quot;,</span></div>
<div class="line"><a name="l00784"></a><span class="lineno">  784</span>&#160;<span class="comment"> *     &quot;channel_codec&quot;          =&gt; TeamSpeak3::CODEC_SPEEX_WIDEBAND,</span></div>
<div class="line"><a name="l00785"></a><span class="lineno">  785</span>&#160;<span class="comment"> *     &quot;channel_flag_permanent&quot; =&gt; TRUE,</span></div>
<div class="line"><a name="l00786"></a><span class="lineno">  786</span>&#160;<span class="comment"> *   ));</span></div>
<div class="line"><a name="l00787"></a><span class="lineno">  787</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00788"></a><span class="lineno">  788</span>&#160;<span class="comment"> *   // create a sub-level channel and get its ID</span></div>
<div class="line"><a name="l00789"></a><span class="lineno">  789</span>&#160;<span class="comment"> *   $sub_cid = $ts3_VirtualServer-&gt;channelCreate(array(</span></div>
<div class="line"><a name="l00790"></a><span class="lineno">  790</span>&#160;<span class="comment"> *     &quot;channel_name&quot;           =&gt; &quot;My Sub-Channel&quot;,</span></div>
<div class="line"><a name="l00791"></a><span class="lineno">  791</span>&#160;<span class="comment"> *     &quot;channel_topic&quot;          =&gt; &quot;This is a sub-level channel&quot;,</span></div>
<div class="line"><a name="l00792"></a><span class="lineno">  792</span>&#160;<span class="comment"> *     &quot;channel_codec&quot;          =&gt; TeamSpeak3::CODEC_SPEEX_NARROWBAND,</span></div>
<div class="line"><a name="l00793"></a><span class="lineno">  793</span>&#160;<span class="comment"> *     &quot;channel_flag_permanent&quot; =&gt; TRUE,</span></div>
<div class="line"><a name="l00794"></a><span class="lineno">  794</span>&#160;<span class="comment"> *     &quot;cpid&quot;                   =&gt; $top_cid,</span></div>
<div class="line"><a name="l00795"></a><span class="lineno">  795</span>&#160;<span class="comment"> *   ));</span></div>
<div class="line"><a name="l00796"></a><span class="lineno">  796</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00797"></a><span class="lineno">  797</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00798"></a><span class="lineno">  798</span>&#160;<span class="comment"> * \subsection example9 9. Send a Text Message to outdated Clients</span></div>
<div class="line"><a name="l00799"></a><span class="lineno">  799</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00800"></a><span class="lineno">  800</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00801"></a><span class="lineno">  801</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00802"></a><span class="lineno">  802</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00803"></a><span class="lineno">  803</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00804"></a><span class="lineno">  804</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00805"></a><span class="lineno">  805</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00806"></a><span class="lineno">  806</span>&#160;<span class="comment"> *   // connect to default update server</span></div>
<div class="line"><a name="l00807"></a><span class="lineno">  807</span>&#160;<span class="comment"> *   $ts3_UpdateServer = TeamSpeak3::factory(&quot;update&quot;);</span></div>
<div class="line"><a name="l00808"></a><span class="lineno">  808</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00809"></a><span class="lineno">  809</span>&#160;<span class="comment"> *   // walk through list of clients on virtual server</span></div>
<div class="line"><a name="l00810"></a><span class="lineno">  810</span>&#160;<span class="comment"> *   foreach($ts3_VirtualServer-&gt;clientList() as $ts3_Client)</span></div>
<div class="line"><a name="l00811"></a><span class="lineno">  811</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00812"></a><span class="lineno">  812</span>&#160;<span class="comment"> *     // skip query clients</span></div>
<div class="line"><a name="l00813"></a><span class="lineno">  813</span>&#160;<span class="comment"> *     if($ts3_Client[&quot;client_type&quot;]) continue;</span></div>
<div class="line"><a name="l00814"></a><span class="lineno">  814</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00815"></a><span class="lineno">  815</span>&#160;<span class="comment"> *     // send test message if client build is outdated</span></div>
<div class="line"><a name="l00816"></a><span class="lineno">  816</span>&#160;<span class="comment"> *     if($ts3_Client-&gt;getRev() &lt; $ts3_UpdateServer-&gt;getClientRev())</span></div>
<div class="line"><a name="l00817"></a><span class="lineno">  817</span>&#160;<span class="comment"> *     {</span></div>
<div class="line"><a name="l00818"></a><span class="lineno">  818</span>&#160;<span class="comment"> *       $ts3_Client-&gt;message(&quot;[COLOR=red]your client is [B]outdated[/B]... update to [U]&quot; . $ts3_UpdateServer-&gt;getClientVersion() . &quot;[/U] now![/COLOR]&quot;);</span></div>
<div class="line"><a name="l00819"></a><span class="lineno">  819</span>&#160;<span class="comment"> *     }</span></div>
<div class="line"><a name="l00820"></a><span class="lineno">  820</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00821"></a><span class="lineno">  821</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00822"></a><span class="lineno">  822</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00823"></a><span class="lineno">  823</span>&#160;<span class="comment"> * \subsection example10 10. Check if the Server Instance is Outdated or Blacklisted</span></div>
<div class="line"><a name="l00824"></a><span class="lineno">  824</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00825"></a><span class="lineno">  825</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00826"></a><span class="lineno">  826</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00827"></a><span class="lineno">  827</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00828"></a><span class="lineno">  828</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the server instance</span></div>
<div class="line"><a name="l00829"></a><span class="lineno">  829</span>&#160;<span class="comment"> *   $ts3_ServerInstance = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/&quot;);</span></div>
<div class="line"><a name="l00830"></a><span class="lineno">  830</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00831"></a><span class="lineno">  831</span>&#160;<span class="comment"> *   // connect to default update server</span></div>
<div class="line"><a name="l00832"></a><span class="lineno">  832</span>&#160;<span class="comment"> *   $ts3_UpdateServer = TeamSpeak3::factory(&quot;update&quot;);</span></div>
<div class="line"><a name="l00833"></a><span class="lineno">  833</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00834"></a><span class="lineno">  834</span>&#160;<span class="comment"> *   // send global text message if the server is outdated</span></div>
<div class="line"><a name="l00835"></a><span class="lineno">  835</span>&#160;<span class="comment"> *   if($ts3_ServerInstance-&gt;version(&quot;build&quot;) &lt; $ts3_UpdateServer-&gt;getServerRev())</span></div>
<div class="line"><a name="l00836"></a><span class="lineno">  836</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00837"></a><span class="lineno">  837</span>&#160;<span class="comment"> *     $ts3_ServerInstance-&gt;message(&quot;[COLOR=red]your server is [B]outdated[/B]... update to [U]&quot; . $ts3_UpdateServer-&gt;getServerVersion() . &quot;[/U]  now![/COLOR]&quot;);</span></div>
<div class="line"><a name="l00838"></a><span class="lineno">  838</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00839"></a><span class="lineno">  839</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00840"></a><span class="lineno">  840</span>&#160;<span class="comment"> *   // connect to default blacklist server</span></div>
<div class="line"><a name="l00841"></a><span class="lineno">  841</span>&#160;<span class="comment"> *   $ts3_BlacklistServer = TeamSpeak3::factory(&quot;blacklist&quot;);</span></div>
<div class="line"><a name="l00842"></a><span class="lineno">  842</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00843"></a><span class="lineno">  843</span>&#160;<span class="comment"> *   // send global text message if the server is blacklisted</span></div>
<div class="line"><a name="l00844"></a><span class="lineno">  844</span>&#160;<span class="comment"> *   if($ts3_BlacklistServer-&gt;isBlacklisted($ts3_ServerInstance))</span></div>
<div class="line"><a name="l00845"></a><span class="lineno">  845</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00846"></a><span class="lineno">  846</span>&#160;<span class="comment"> *     $ts3_ServerInstance-&gt;message(&quot;[COLOR=red]your server is [B]blacklisted[/B]... disconnect now![/COLOR]&quot;);</span></div>
<div class="line"><a name="l00847"></a><span class="lineno">  847</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00848"></a><span class="lineno">  848</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00849"></a><span class="lineno">  849</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00850"></a><span class="lineno">  850</span>&#160;<span class="comment"> * \subsection example11 11. Create a simple TSViewer for your Website</span></div>
<div class="line"><a name="l00851"></a><span class="lineno">  851</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00852"></a><span class="lineno">  852</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00853"></a><span class="lineno">  853</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00854"></a><span class="lineno">  854</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00855"></a><span class="lineno">  855</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00856"></a><span class="lineno">  856</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00857"></a><span class="lineno">  857</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00858"></a><span class="lineno">  858</span>&#160;<span class="comment"> *   // build and display HTML treeview using custom image paths (remote icons will be embedded using data URI sheme)</span></div>
<div class="line"><a name="l00859"></a><span class="lineno">  859</span>&#160;<span class="comment"> *   echo $ts3_VirtualServer-&gt;getViewer(new TeamSpeak3_Viewer_Html(&quot;images/viewericons/&quot;, &quot;images/countryflags/&quot;, &quot;data:image&quot;));</span></div>
<div class="line"><a name="l00860"></a><span class="lineno">  860</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00861"></a><span class="lineno">  861</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00862"></a><span class="lineno">  862</span>&#160;<span class="comment"> * \subsection example12 12. Update all outdated Audio Codecs to their Opus equivalent</span></div>
<div class="line"><a name="l00863"></a><span class="lineno">  863</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00864"></a><span class="lineno">  864</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00865"></a><span class="lineno">  865</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00866"></a><span class="lineno">  866</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00867"></a><span class="lineno">  867</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00868"></a><span class="lineno">  868</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00869"></a><span class="lineno">  869</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00870"></a><span class="lineno">  870</span>&#160;<span class="comment"> *   // walk through list of chanels</span></div>
<div class="line"><a name="l00871"></a><span class="lineno">  871</span>&#160;<span class="comment"> *   foreach($ts3_VirtualServer-&gt;channelList() as $ts3_Channel)</span></div>
<div class="line"><a name="l00872"></a><span class="lineno">  872</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00873"></a><span class="lineno">  873</span>&#160;<span class="comment"> *     if($ts3_Channel[&quot;channel_codec&quot;] == TeamSpeak3::CODEC_CELT_MONO)</span></div>
<div class="line"><a name="l00874"></a><span class="lineno">  874</span>&#160;<span class="comment"> *     {</span></div>
<div class="line"><a name="l00875"></a><span class="lineno">  875</span>&#160;<span class="comment"> *       $ts3_Channel[&quot;channel_codec&quot;] = TeamSpeak3::CODEC_OPUS_MUSIC;</span></div>
<div class="line"><a name="l00876"></a><span class="lineno">  876</span>&#160;<span class="comment"> *     }</span></div>
<div class="line"><a name="l00877"></a><span class="lineno">  877</span>&#160;<span class="comment"> *     elseif($ts3_Channel[&quot;channel_codec&quot;] != TeamSpeak3::CODEC_OPUS_MUSIC)</span></div>
<div class="line"><a name="l00878"></a><span class="lineno">  878</span>&#160;<span class="comment"> *     {</span></div>
<div class="line"><a name="l00879"></a><span class="lineno">  879</span>&#160;<span class="comment"> *       $ts3_Channel[&quot;channel_codec&quot;] = TeamSpeak3::CODEC_OPUS_VOICE;</span></div>
<div class="line"><a name="l00880"></a><span class="lineno">  880</span>&#160;<span class="comment"> *     }</span></div>
<div class="line"><a name="l00881"></a><span class="lineno">  881</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00882"></a><span class="lineno">  882</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00883"></a><span class="lineno">  883</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00884"></a><span class="lineno">  884</span>&#160;<span class="comment"> * \subsection example13 13. Display the Avatar of a connected User</span></div>
<div class="line"><a name="l00885"></a><span class="lineno">  885</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00886"></a><span class="lineno">  886</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00887"></a><span class="lineno">  887</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00888"></a><span class="lineno">  888</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00889"></a><span class="lineno">  889</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00890"></a><span class="lineno">  890</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00891"></a><span class="lineno">  891</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00892"></a><span class="lineno">  892</span>&#160;<span class="comment"> *   // spawn an object for the client using a specified nickname</span></div>
<div class="line"><a name="l00893"></a><span class="lineno">  893</span>&#160;<span class="comment"> *   $ts3_Client = $ts3_VirtualServer-&gt;clientGetByName(&quot;John Doe&quot;);</span></div>
<div class="line"><a name="l00894"></a><span class="lineno">  894</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00895"></a><span class="lineno">  895</span>&#160;<span class="comment"> *   // download the clients avatar file</span></div>
<div class="line"><a name="l00896"></a><span class="lineno">  896</span>&#160;<span class="comment"> *   $avatar = $ts3_Client-&gt;avatarDownload();</span></div>
<div class="line"><a name="l00897"></a><span class="lineno">  897</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00898"></a><span class="lineno">  898</span>&#160;<span class="comment"> *   // send header and display image</span></div>
<div class="line"><a name="l00899"></a><span class="lineno">  899</span>&#160;<span class="comment"> *   header(&quot;Content-Type: &quot; . TeamSpeak3_Helper_Convert::imageMimeType($avatar));</span></div>
<div class="line"><a name="l00900"></a><span class="lineno">  900</span>&#160;<span class="comment"> *   echo $avatar;</span></div>
<div class="line"><a name="l00901"></a><span class="lineno">  901</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00902"></a><span class="lineno">  902</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00903"></a><span class="lineno">  903</span>&#160;<span class="comment"> * \subsection example14 14. Create a Simple Bot waiting for Events</span></div>
<div class="line"><a name="l00904"></a><span class="lineno">  904</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00905"></a><span class="lineno">  905</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00906"></a><span class="lineno">  906</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00907"></a><span class="lineno">  907</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00908"></a><span class="lineno">  908</span>&#160;<span class="comment"> *   // connect to local server in non-blocking mode, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00909"></a><span class="lineno">  909</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&amp;blocking=0&quot;);</span></div>
<div class="line"><a name="l00910"></a><span class="lineno">  910</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00911"></a><span class="lineno">  911</span>&#160;<span class="comment"> *   // get notified on incoming private messages</span></div>
<div class="line"><a name="l00912"></a><span class="lineno">  912</span>&#160;<span class="comment"> *   $ts3_VirtualServer-&gt;notifyRegister(&quot;textprivate&quot;);</span></div>
<div class="line"><a name="l00913"></a><span class="lineno">  913</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00914"></a><span class="lineno">  914</span>&#160;<span class="comment"> *   // register a callback for notifyTextmessage events </span></div>
<div class="line"><a name="l00915"></a><span class="lineno">  915</span>&#160;<span class="comment"> *   TeamSpeak3_Helper_Signal::getInstance()-&gt;subscribe(&quot;notifyTextmessage&quot;, &quot;onTextmessage&quot;);</span></div>
<div class="line"><a name="l00916"></a><span class="lineno">  916</span>&#160;<span class="comment"> *   </span></div>
<div class="line"><a name="l00917"></a><span class="lineno">  917</span>&#160;<span class="comment"> *   // wait for events</span></div>
<div class="line"><a name="l00918"></a><span class="lineno">  918</span>&#160;<span class="comment"> *   while(1) $ts3_VirtualServer-&gt;getAdapter()-&gt;wait();</span></div>
<div class="line"><a name="l00919"></a><span class="lineno">  919</span>&#160;<span class="comment"> *  </span></div>
<div class="line"><a name="l00920"></a><span class="lineno">  920</span>&#160;<span class="comment"> *   // define a callback function</span></div>
<div class="line"><a name="l00921"></a><span class="lineno">  921</span>&#160;<span class="comment"> *   function onTextmessage(TeamSpeak3_Adapter_ServerQuery_Event $event, TeamSpeak3_Node_Host $host)</span></div>
<div class="line"><a name="l00922"></a><span class="lineno">  922</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00923"></a><span class="lineno">  923</span>&#160;<span class="comment"> *     echo &quot;Client &quot; . $event[&quot;invokername&quot;] . &quot; sent textmessage: &quot; . $event[&quot;msg&quot;];</span></div>
<div class="line"><a name="l00924"></a><span class="lineno">  924</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00925"></a><span class="lineno">  925</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00926"></a><span class="lineno">  926</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00927"></a><span class="lineno">  927</span>&#160;<span class="comment"> * \subsection example15 15. Handle Errors using Exceptions and Custom Error Messages</span></div>
<div class="line"><a name="l00928"></a><span class="lineno">  928</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00929"></a><span class="lineno">  929</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00930"></a><span class="lineno">  930</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00931"></a><span class="lineno">  931</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00932"></a><span class="lineno">  932</span>&#160;<span class="comment"> *   // register custom error message (supported placeholders are: %file, %line, %code and %mesg)</span></div>
<div class="line"><a name="l00933"></a><span class="lineno">  933</span>&#160;<span class="comment"> *   TeamSpeak3_Exception::registerCustomMessage(0x300, &quot;The specified channel does not exist; server said: %mesg&quot;);</span></div>
<div class="line"><a name="l00934"></a><span class="lineno">  934</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00935"></a><span class="lineno">  935</span>&#160;<span class="comment"> *   try</span></div>
<div class="line"><a name="l00936"></a><span class="lineno">  936</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00937"></a><span class="lineno">  937</span>&#160;<span class="comment"> *     // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00938"></a><span class="lineno">  938</span>&#160;<span class="comment"> *     $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00939"></a><span class="lineno">  939</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00940"></a><span class="lineno">  940</span>&#160;<span class="comment"> *     // spawn an object for the channel using a specified name</span></div>
<div class="line"><a name="l00941"></a><span class="lineno">  941</span>&#160;<span class="comment"> *     $ts3_Channel = $ts3_VirtualServer-&gt;channelGetByName(&quot;I do not exist&quot;);</span></div>
<div class="line"><a name="l00942"></a><span class="lineno">  942</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00943"></a><span class="lineno">  943</span>&#160;<span class="comment"> *   catch(TeamSpeak3_Exception $e)</span></div>
<div class="line"><a name="l00944"></a><span class="lineno">  944</span>&#160;<span class="comment"> *   {</span></div>
<div class="line"><a name="l00945"></a><span class="lineno">  945</span>&#160;<span class="comment"> *     // print the error message returned by the server</span></div>
<div class="line"><a name="l00946"></a><span class="lineno">  946</span>&#160;<span class="comment"> *     echo &quot;Error &quot; . $e-&gt;getCode() . &quot;: &quot; . $e-&gt;getMessage();</span></div>
<div class="line"><a name="l00947"></a><span class="lineno">  947</span>&#160;<span class="comment"> *   }</span></div>
<div class="line"><a name="l00948"></a><span class="lineno">  948</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00949"></a><span class="lineno">  949</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00950"></a><span class="lineno">  950</span>&#160;<span class="comment"> * \subsection example16 16. Save Connection State in Persistent Session Variable</span></div>
<div class="line"><a name="l00951"></a><span class="lineno">  951</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00952"></a><span class="lineno">  952</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00953"></a><span class="lineno">  953</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00954"></a><span class="lineno">  954</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00955"></a><span class="lineno">  955</span>&#160;<span class="comment"> *   // start a PHP session</span></div>
<div class="line"><a name="l00956"></a><span class="lineno">  956</span>&#160;<span class="comment"> *   session_start();</span></div>
<div class="line"><a name="l00957"></a><span class="lineno">  957</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00958"></a><span class="lineno">  958</span>&#160;<span class="comment"> *   // connect to local server, authenticate and spawn an object for the virtual server on port 9987</span></div>
<div class="line"><a name="l00959"></a><span class="lineno">  959</span>&#160;<span class="comment"> *   $ts3_VirtualServer = TeamSpeak3::factory(&quot;serverquery://username:password@127.0.0.1:10011/?server_port=9987&quot;);</span></div>
<div class="line"><a name="l00960"></a><span class="lineno">  960</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00961"></a><span class="lineno">  961</span>&#160;<span class="comment"> *   // save connection state (including login and selected virtual server)</span></div>
<div class="line"><a name="l00962"></a><span class="lineno">  962</span>&#160;<span class="comment"> *   $_SESSION[&quot;_TS3&quot;] = serialize($ts3_VirtualServer);</span></div>
<div class="line"><a name="l00963"></a><span class="lineno">  963</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00964"></a><span class="lineno">  964</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00965"></a><span class="lineno">  965</span>&#160;<span class="comment"> * \subsection example17 17. Restore Connection State from Persistent Session Variable</span></div>
<div class="line"><a name="l00966"></a><span class="lineno">  966</span>&#160;<span class="comment"> * @code</span></div>
<div class="line"><a name="l00967"></a><span class="lineno">  967</span>&#160;<span class="comment"> *   // load framework files</span></div>
<div class="line"><a name="l00968"></a><span class="lineno">  968</span>&#160;<span class="comment"> *   require_once(&quot;libraries/TeamSpeak3/TeamSpeak3.php&quot;);</span></div>
<div class="line"><a name="l00969"></a><span class="lineno">  969</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00970"></a><span class="lineno">  970</span>&#160;<span class="comment"> *   // start a PHP session</span></div>
<div class="line"><a name="l00971"></a><span class="lineno">  971</span>&#160;<span class="comment"> *   session_start();</span></div>
<div class="line"><a name="l00972"></a><span class="lineno">  972</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00973"></a><span class="lineno">  973</span>&#160;<span class="comment"> *   // restore connection state</span></div>
<div class="line"><a name="l00974"></a><span class="lineno">  974</span>&#160;<span class="comment"> *   $ts3_VirtualServer = unserialize($_SESSION[&quot;_TS3&quot;]);</span></div>
<div class="line"><a name="l00975"></a><span class="lineno">  975</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00976"></a><span class="lineno">  976</span>&#160;<span class="comment"> *   // send a text message to the server</span></div>
<div class="line"><a name="l00977"></a><span class="lineno">  977</span>&#160;<span class="comment"> *   $ts3_VirtualServer-&gt;message(&quot;Hello World!&quot;);</span></div>
<div class="line"><a name="l00978"></a><span class="lineno">  978</span>&#160;<span class="comment"> * @endcode</span></div>
<div class="line"><a name="l00979"></a><span class="lineno">  979</span>&#160;<span class="comment"> *</span></div>
<div class="line"><a name="l00980"></a><span class="lineno">  980</span>&#160;<span class="comment"> * Speed up new development and reduce maintenance costs by using the TS3 PHP Framework!</span></div>
<div class="line"><a name="l00981"></a><span class="lineno">  981</span>&#160;<span class="comment"> */</span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_8c6eb96e4942c21c15d2738fe9c923ec.html">TeamSpeak3</a></li><li class="navelem"><a class="el" href="_team_speak3_8php.html">TeamSpeak3.php</a></li>
    <li class="footer">Generated on Fri Oct 11 2013 23:35:43 for TeamSpeak 3 PHP Framework by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.4 </li>
  </ul>
</div>
</body>
</html>
